Message
Message steps allow you to add a standalone message where you want in your Canvas Flow.
Create a message
To create a Message component, first add a step to your Canvas. Drag and drop the component from the sidebar, or click the plus button at the bottom of a step and select Message.
Set up messages
All users who enter the Message step will advance to the next step when any one of the following conditions is met:
- Any message is sent
- A message is frequency capped and not sent
- A message is aborted
- A user isn’t reachable by channel, so the message is not sent
If an action-based Canvas is triggered by an inbound SMS message, you can reference SMS properties in the first step (Message step) or a Message step that is nested under an Action Path step. For example, in the Message step, you could use {{sms.${inbound_message_body}}}
or {{sms.${inbound_media_urls}}}
.
Edit delivery settings
The Message component also includes settings for Intelligent Delivery, Quiet Hours overrides, and delivery validation. You can enable Intelligent Timing with a fallback option when a user’s profile does not have enough data to calculate an optimal time. We recommend enabling Intelligent Timing and rate limiting as an additional check for any delays between users entering the Message step and the actual message sending.
Select Using Intelligent Timing in the Delivery Settings tab. Here, you can select either the most popular time or a specific fallback time. If Quiet Hours are enabled, the Message step also allows you to override this setting.
Delivery validations provide an additional check to confirm your audience meets the delivery criteria at message send. This setting is recommended if Quiet Hours, Intelligent Timing, or rate limiting are activated. You can add a segment or additional filters to validate at the time of the message being sent. If a user doesn’t meet the set delivery validations for a Message step, they will exit the Canvas at the step.
Canvas entry properties
Canvas entry properties are configured in the Entry Schedule step of creating a Canvas and will indicate the trigger that enters a user into a Canvas. These properties can also access the properties of entry payloads in API-triggered Canvases. Note that the canvas_entry_properties
object has a maximum size limit of 50 KB.
For in-app message channels specifically, canvas_entry_properties
can only be referenced in Canvas Flow and in the original Canvas editor if you have persistent entry properties enabled in the original editor as part of the previous early access.
Canvas Flow
For Canvas Flow messaging, entry properties can be used in Liquid in any Message step. Use the following Liquid when referencing these entry properties: canvas_entry_properties${property_name}
. Events must be custom events or purchase events to be used this way.
Use the following Liquid when referencing these entry properties: canvas_entry_properties${property_name}
. Note that the events must be custom events or purchase events to be used this way.
For example, consider the following request: \"canvas_entry_properties\" : {\"product_name\" : \"shoes\", \"product_price\" : 79.99}
. You could add the word “shoes” to a message with the Liquid {{canvas_entry_properties.${product_name}}}
.
You can also leverage persistent entry properties in any Message step to guide your users through personalized steps throughout your Canvas workflow.
Original workflow
For the Canvases built with the original editor, canvas_entry_properties
can be referenced only in the first full step of a Canvas.
Event properties
Event properties refer to the properties that you set for custom events and purchases. These event_properties
can be used in campaigns with action-based delivery as well as Canvases.
Canvas Flow
In Canvas Flow, custom event and purchase event properties can be used in Liquid in any Message step that follows an Action Paths step. For Canvas Flow, use this Liquid {{event_properties.${property_name}}}
when referencing these event_properties
. These events must be custom events or purchase events to be used this way in the Message component.
event_properties
cannot be used independently of Action Paths for Canvas Flow.
In the first Message step following an Action Path, you can use event_properties
related to the event referenced in that Action Path. You can have other steps (that are not another Action Paths or Message step) in between this Action Paths step and the Message step. Note that you’ll only have access to event_properties
if your Message step can be traced back to a non-Everyone Else path in an Action Path step.
Original workflow
event_properties
can be used in the first full step in an action-based Canvas using the original workflow, even if the full step is scheduled.
For Canvas Flow and the original editor, you can’t use event_properties
in the lead Message step. Instead, you must use canvas_entry_properties
or add an Action Paths step with the corresponding event before the Message step that includes event_properties
.
For more information and examples, check out Canvas entry properties and event properties.
Analytics
Refer to the following table for definitions of Message component metrics:
Metric | Description |
---|---|
Entries | The number of times the step has been entered. If your Canvas has re-eligibility and a user enters a Message step twice, two entries will be recorded. |
Proceeded to Next Step | The number of entries that proceeded to the next step in the Canvas. |
Sends | The total number of messages the step has sent. If your Canvas re-eligibility and a user enters a Message step twice, two entries will be recorded. |
Unique Recipients | The number of users who have received messages from this step. |
Primary Conversion Event | The number of times a defined event occurred after interacting with or viewing a received message from a Braze campaign. You define this event when building the campaign. |
Revenue | The total revenue in dollars from campaign recipients within the set primary conversion window. |