Braze
Braze is a customer engagement platform that helps you communicate with your patients.
Braze is a customer engagement platform that helps you communicate with your patients.
Category: Communication. Adds 6 actions 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 |
|---|---|---|
| API Key | Yes | Used to authenticate with Braze Stored as a secret. |
| App ID | No | Specifies the app within your workspace that extension activity should be associated with. Can also be provided via the action field. |
| Base URL | Yes | The base URL of the Braze instance |
Actions
Braze adds these 6 actions to a care flow. Add one to a step, then fill in its inputs.
Schedule Email
Schedule an email to be sent to a patient.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| External User ID | string | Yes | The ID of the user in your system that this message is being sent to. |
| App ID | string | No | Specifies the app within your Braze workspace the activity will be associated with. Can also be provided via the extension settings. |
| From | string | Yes | valid email address in the format "Display Name <email@address.com>" |
| Reply To | string | No | Valid email address in the format "email@address.com" - defaults to your workspace`s default reply to if not set |
| Subject | string | No | The subject of the email. |
| Body | html | Yes | The body of the email. |
| Preheader | string | No | The preheader of the email. Recommended length 50-100 characters |
| Should inline CSS | boolean | No | Whether to inline the CSS of the body of the email. If not provided, falls back to the default CSS inlining value for the workspace |
| Schedule Time | date | Yes | The time to schedule the SMS to be sent. Must be a datetime as ISO 8601 string and time to send the message in UTC |
| In Patient Local Time | boolean | No | If true, the schedule time will be in the patient's local time. |
| At Optimal Time | boolean | No | If true, the schedule time will be at the optimal time. |
| Campaign ID | string | No | Optional but required if you wish to track campaign stats |
| Message Variantion ID | string | No | Used when providing a campaign_id to specify which message variation this message should be tracked under |
Returns:
| Data point | Type |
|---|---|
EmailDispatchId | string |
Schedule an email to be sent at a specific time
Required permissions: messages.schedule.create
Schedule SMS
Schedule an SMS to be sent immediateky to a patient.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Subscription Group ID | string | Yes | The ID of your subscription group. |
| External User ID | string | Yes | The ID of the user in your system that this message is being sent to. |
| Body | text | Yes | The body of the SMS. |
| App ID | string | No | Specifies the app within your Braze workspace the activity will be associated with. Can also be provided via the extension settings. |
| Schedule Time | date | Yes | The time to schedule the SMS to be sent. Must be a datetime as ISO 8601 string and time to send the message in UTC |
| In Patient Local Time | boolean | No | If true, the schedule time will be in the patient's local time. |
| At Optimal Time | boolean | No | If true, the schedule time will be at the optimal time. |
| Link Shortening Enabled | boolean | No | Use this field to turn on link shortening and campaign-level click tracking |
| Use Click Tracking Enabled | boolean | No | If Link Shortening Enabled is true, use this field to turn on link shortening, and campaign-level and user-level click tracking |
| Campaign ID | string | No | Optional but required if you wish to track campaign stats |
| Message Variantion ID | string | No | Used when providing a campaign_id to specify which message variation this message should be tracked under |
Returns:
| Data point | Type |
|---|---|
SMSDispatchId | string |
SMSScheduleId | string |
Schedule an SMS message to be sent at a specific time
Required permissions: messages.schedule.create
Send campaign
Send a campaign with Braze
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Campaign ID | string | Yes | The ID of the campaign to send the email with attributes to. |
| Send ID | string | No | Send identifier (optional) |
| External User ID | string | No | The ID of the user in your system that this message is being sent to. Either external_user_id or email must be provided. |
string | No | The email address of the user to send the email to. Either External User ID or Email must be provided. | |
| Trigger Properties | json | No | Key-value pairs that can be referenced in your message template to personalize it and insert dynamic content. |
| Attributes | json | No | Create or update user-specific profile attribute. Attributes can trigger campaigns, can be used for segmentation, and personalization of messages. |
Returns:
| Data point | Type |
|---|---|
EmailDispatchId | string |
Send a campaign message.
Required permissions: campaigns.trigger.send
Send Email
Send an email to a patient.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| External User ID | string | Yes | The ID of the user in your system that this message is being sent to. |
| App ID | string | No | Specifies the app within your Braze workspace the activity will be associated with. Can also be provided via the extension settings. |
| From | string | Yes | valid email address in the format "Display Name <email@address.com>" |
| Reply To | string | No | Valid email address in the format "email@address.com" - defaults to your workspace`s default reply to if not set |
| Subject | string | No | The subject of the email. |
| Body | html | Yes | The body of the email. |
| Preheader | string | No | The preheader of the email. Recommended length 50-100 characters |
| Should inline CSS | boolean | No | Whether to inline the CSS of the body of the email. If not provided, falls back to the default CSS inlining value for the workspace |
| Campaign ID | string | No | Optional but required if you wish to track campaign stats |
| Message Variantion ID | string | No | Used when providing a campaign_id to specify which message variation this message should be tracked under |
Returns:
| Data point | Type |
|---|---|
EmailDispatchId | string |
Send an immediate email to a specified user
Required permissions: messages.send
Send Email Using Template
Send an email to a patient using a template. You can schedule the email to be sent at a later time.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| External User ID | string | Yes | The ID of the user in your system that this message is being sent to. |
| App ID | string | No | Specifies the app within your Braze workspace the activity will be associated with. Can also be provided via the extension settings. |
| From | string | Yes | valid email address in the format "Display Name <email@address.com>" |
| Template ID | string | Yes | The ID of the template to use. |
| Reply To | string | No | Valid email address in the format "email@address.com" - defaults to your workspace`s default reply to if not set |
| Preheader | string | No | The preheader of the email. Recommended length 50-100 characters |
| Schedule Time | date | No | The time to schedule the SMS to be sent. Must be a datetime as ISO 8601 string and time to send the message in UTC |
| In Patient Local Time | boolean | No | If true, the schedule time will be in the patient's local time. |
| At Optimal Time | boolean | No | If true, the schedule time will be at the optimal time. |
| Campaign ID | string | No | Optional but required if you wish to track campaign stats |
| Message Variantion ID | string | No | Used when providing a campaign_id to specify which message variation this message should be tracked under |
Returns:
| Data point | Type |
|---|---|
EmailDispatchId | string |
Send an email using a pre-defined Braze template
Required permissions: messages.send
Send SMS
Send an SMS to a patient.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Subscription Group ID | string | Yes | The ID of your subscription group. |
| External User ID | string | Yes | The ID of the user in your system that this message is being sent to. |
| Body | text | Yes | The body of the SMS. |
| App ID | string | No | Specifies the app within your Braze workspace the activity will be associated with. Can also be provided via the extension settings. |
| Link Shortening Enabled | boolean | No | Use this field to turn on link shortening and campaign-level click tracking |
| Use Click Tracking Enabled | boolean | No | If Link Shortening Enabled is true, use this field to turn on link shortening, and campaign-level and user-level click tracking |
| Campaign ID | string | No | Optional but required if you wish to track campaign stats |
| Message Variantion ID | string | No | Used when providing a campaign_id to specify which message variation this message should be tracked under |
Returns:
| Data point | Type |
|---|---|
SMSDispatchId | string |
Send an immediate SMS message to a specified user
Required permissions: messages.send
Setup and notes
Braze is a comprehensive customer engagement platform that specializes in helping businesses connect with their users through personalized messaging channels.
Extension settings
An api key and the REST Endpoint URL are needed to be provided in order for the extension to authenticate with Braze's API.
An app ID can also be specified via the extension settings or the action field. Actions requiring an app ID to be provided will throw an error if no app ID is provided via the extension settings or the action field. If both are provided, the app ID from the action field will be used.
List of URLs can be found here - make sure it's the REST Endpoint URL. Documentation on API keys can be found here.
Supported Actins
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.