Text-em-all
Send text messages to your patients.
Send text messages to your patients.
Category: Communication. Adds 1 action and 1 webhook to a care flow.
What to configure
Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.
| Setting | Required | Notes |
|---|---|---|
| Customer Key | Yes | Your Text-Em-All customer key. Stored as a secret. |
| Customer Secret | Yes | Your Text-Em-All customer secret. Stored as a secret. |
| Token | Yes | Your Text-Em-All token. Stored as a secret. |
Actions
Text-em-all adds this action to a care flow. Add one to a step, then fill in its inputs.
Send a new SMS broadcast
Send a text message to a recipient. Returns the delivery result (sent, invalid_number, failed, etc.) for triage purposes.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Broadcast Name | string | Yes | The name of the broadcast. |
| Phone Number | string | No | The primary phone number of the recipient. Must be a valid NANP phone number. If omitted, falls back to the patient mobile phone from their profile. |
| First Name | string | No | The first name of the contact. If omitted, falls back to the patient first name from their profile. |
| Last Name | string | No | The last name of the contact. If omitted, falls back to the patient last name from their profile. |
| Notes | string | No | Notes about the contact (e.g., "Eligibility form from Awell"). |
| Integration Data | string | No | Extra field for integration information. |
| Text Message | text | Yes | The text of the message for a text type broadcast. The max length is based on the setting in your account. |
| Text Number ID | numeric | No | The ID of the text number your messages will be sent from. If omitted, the default text number on your account will be used. |
| Start Date | date | No | The time the broadcast should start. Will default to start immediately. If provided must be a datetime as ISO 8601 string and time to send the message in UTC |
| Check Calling Window | boolean | No | Whether to enforce the calling window restrictions. Defaults to false. |
Returns:
| Data point | Type |
|---|---|
broadcastId | number |
broadcastStartDate | string |
broadcastStatus | string |
broadcastStatusCategory | string |
deliveryResult | string |
deliveryResultDetails | string |
success | boolean |
uriBroadcastDetails | string |
Webhooks
Text-em-all can send this event into Awell, where each one can start a care flow or move a patient along. Point the webhook at the URL Studio shows you when you enable it.
broadcastStatusChange
Payload:
| Data point | Type |
|---|---|
broadcastId | number |
broadcastStatus | string |
Setup and notes
Text-Em-All is a texting and automated calling service that enables organizations to communicate with patients.
Supported Actions
- **sendSMSBroadcast - Schedule SMS message to a specified user
- sendCallBroadcast** - Schedule an Call message to a specified user
Webhooks
Broadcast Status Change
Triggered when the status of a call or text broadcast changes to one of the following states:
| Status | Description |
|---|---|
created | A broadcast has been created on your Call-Em-All account. It may be scheduled to run in the future and it may not have all the information set up to run yet. |
ready | The broadcast has all information necessary to run and is waiting for its start time. |
broadcasting | The broadcast started to send out phone calls or text messages. |
completed | The broadcast has finished sending out all phone calls or text messages. |
paused | The broadcast has been paused and no calls or texts are going out. |
resumed | A paused broadcast resumes. |
canceled | The broadcast was canceled. |
expired | The window that was set up for the broadcast by the user was insufficient to send out all the calls or texts. The broadcast has been expired and some of the calls and texts are not delivered. |
Webhook includes:
- Broadcast ID
- Broadcast status
Setup
The Text-Em-All extension requires the following settings to be configured:
| Setting name | Required | Description |
|---|---|---|
customerKey | Yes | Your Text-Em-All customer key |
customerSecret | Yes | Your Text-Em-All customer secret |
token | Yes | Your Text-Em-All token |
baseUrl | Yes | Your Text-Em-All base URL |
Find out more
For detailed information about setting up webhooks, notification formats, and additional event types, please visit the Text-Em-All Webhooks documentation.
Where this page comes from
The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the
platform actually does rather than a description of it.
Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.