SMS Settings
SMS Settings holds the Twilio details PeakIDX uses to send and receive texts for the selected site. Each site has its own settings. Only site administrators can open this page.
Open it from the SMS Settings button at the top of the SMS Inbox.
You need a Twilio account with a phone number that can send texts. PeakIDX does not provide the account or number.
Fields
| Field | Description |
|---|---|
| Twilio Account SID | The Account SID from your Twilio console. |
| Twilio Auth Token | The Auth Token from your Twilio console. |
| From number | Your Twilio number, for example +15551234567. A 10 digit US or Canadian number is accepted and converted. |
| Business name | Added to the first message sent to a number, and used in the STOP, START and HELP replies. Up to 100 characters. |
| SMS enabled | Yes or No. Nothing is sent while this is No. |
| Send texts no earlier than | The first hour of the day automated texts may go out, in your site's time zone. Default 8:00 AM. |
| Send texts no later than | The hour after which automated texts stop for the day, in your site's time zone. Default 9:00 PM. A text is sent up to, but not including, this hour. |
| Text assigned agent when a new lead arrives | Yes or No. When Yes, the agent a new lead is assigned to gets a text, provided that agent has opted in (see below). |
Quiet Hours
Marketing and automated texts are only sent between the two sending times above, using the time zone set in your site settings. This covers campaign SMS steps and appointment SMS reminders. A text that comes due outside the window is not dropped and not skipped. PeakIDX holds it and tries again on its next hourly run, so it goes out in the first hour that falls inside the window. A campaign stays on the same step until then, and an appointment reminder is not marked as sent while it waits. The start time must be earlier than the end time.
Texts you send yourself from a lead page are not held back, and neither are the automatic replies to STOP, START and HELP, because those are answers to a message the person just sent. The new lead text to an agent is also not held back.
Unfilled Placeholders
Library templates contain bracketed placeholders such as [neighborhood] that you are meant to replace. PeakIDX will not send an email or a text whose subject or body still contains one. Nothing is sent, and when the message was for a lead, the lead's timeline shows "Not sent: unfilled [placeholder]". If you send a text by hand, the page tells you which placeholder is left. Edit the template or message and send again. Sending yourself a test email shows a warning instead of blocking.
Auth Token Handling
The token is never shown back on the page. The page shows only a masked version of the token on file (the last 4 characters). Leave the token field blank when saving to keep the stored token. Enter a new value only to replace it.
Encryption of the Auth Token
The auth token is encrypted in the database (AES-256-GCM) before it is stored. This requires the server setting PEAKIDX_CRM_ENCRYPTION_KEY, a Base64-encoded 32-byte key, to be configured by whoever runs the PeakIDX server. If the key is missing or invalid, saving a token fails with "Failed to save SMS settings." and nothing is stored. If an older plaintext token is still on file, it is converted to the encrypted form the next time you save these settings, which also needs the key. If a stored token cannot be decrypted (for example the key was changed), SMS behaves as if no token is configured until you enter the token again.
Required to Enable
To save with SMS enabled set to Yes, you must provide the Account SID, a valid from number, a business name, and an auth token (either typed now or already stored). Saving with No does not require them.
Agent Lead Alerts by Text
Besides the email, PeakIDX can text the agent a new lead is assigned to. Two things must be true: the site toggle above is Yes (and SMS is enabled and set up), and the agent has opted in.
Each agent opts in on their own Edit Profile page, with the site selected. They enter a mobile number and choose Yes for "Text me when a new lead is assigned to me". Saving records the agent's consent for that number with the source agent_lead_alert. Agents who do not opt in are never texted, and the email notification is unchanged.
The text reads like "New lead: Jane Smith 555-123-4567 Contact. https://account.peakidxsites.com/account/leads/view?lead_id=123" and includes a link to the lead in the portal. The first text to a number also carries your business name and the STOP notice. If an agent replies STOP, they are opted out through the same inbound webhook as leads and the alerts stop until they reply START or opt in again on their profile. These texts appear in the SMS log but not on the lead's timeline. A failed text never delays or blocks the lead from being created.
Point Twilio at PeakIDX
Replies and STOP messages reach PeakIDX only if Twilio is told where to send them.
- Open SMS Settings in PeakIDX. The page shows the webhook address for your site. It is your site's domain followed by
/sms-inbound. - In the Twilio console, open the phone number you entered as the from number.
- Set the incoming message ("A message comes in") webhook to that address, using HTTP POST.
- Save in Twilio.
PeakIDX checks the Twilio signature on every request using the site's auth token. A request with a missing or wrong signature is rejected with a 403 error and nothing is stored. If the Auth Token in PeakIDX does not match your Twilio account, inbound messages will be rejected.
Delivery status
You do not need to configure anything in Twilio for delivery status. Each outbound message PeakIDX sends tells Twilio to report status changes to your site's address followed by /sms-status. That request is checked with the same Twilio signature rule as inbound messages, and an unsigned or wrongly signed request gets a 403 and changes nothing. See SMS for how the status is updated.
Messages sent to any number other than the saved from number are ignored.