Braze Cloud Mode (Actions) Destination

Braze, formerly Appboy, is an engagement platform that empowers growth by helping marketing teams to build customer loyalty through mobile, omni-channel customer experiences.

Benefits of Braze Cloud Mode (Actions) vs Braze Classic

Braze Cloud Mode (Actions) provides the following benefit over Braze Classic:

• E-commerce mappings. Segment implementations that don’t follow the e-commerce spec due to incompatible event names (for example, Trip Booked vs Order Completed) can use Event Triggers to log purchases in Braze Cloud Mode (Actions).

Getting Started

1. From the Segment web app, click Catalog.
2. Search for “Braze” in the Catalog, select Braze Cloud Mode (Actions), and choose which of your sources to connect the destination to.
3. Add the following Connection Settings:
   • API Key: Created under Developer Console in the Braze Dashboard.
   • App ID: The app identifier used to reference specific Apps in requests made to the Braze API. Created under Developer Console in the Braze Dashboard.
   • REST Endpoint: Your Braze REST Endpoint. For more information, see API Overview in the Braze documentation.

Destination Settings

Setting	Description
API Key	Required. Created under Developer Console in the Braze Dashboard.
App ID	The app identifier used to reference specific Apps in requests made to the Braze API. Created under Developer Console in the Braze Dashboard.
REST Endpoint	Required. Your Braze REST endpoint. See more details

Available Presets

Braze Cloud Mode (Actions) has the following presets:

Preset Name	Trigger	Default Action
Order Completed Calls	Event event = "Order Completed"	Track Purchase
Track Calls	Event type = "track" and event != "Order Completed"	Track Event
Identify Calls	Event type = "identify"	Update User Profile

Available Actions

Build your own Mappings. Combine supported triggers with the following Braze Cloud Mode-supported actions:

• Update User Profile

• Track Event

• Track Purchase

• Debounce Middleware

• Identify User

• Create Alias

Update User Profile

Update a user’s profile attributes in Braze

Update User Profile is a Cloud action. The default Trigger is: type = "identify"

Click to show / hide fields

Track Event

Record custom events in Braze

Track Event is a Cloud action. The default Trigger is: type = "track" and event != "Order Completed"

Click to show / hide fields

Track Purchase

Record purchases in Braze

Track Purchase is a Cloud action. The default Trigger is: event = "Order Completed"

Click to show / hide fields

Debounce Middleware

When enabled, it ensures that only events where at least one changed trait value are sent to Braze, and events with duplicate traits are not sent. Debounce functionality requires a frontend client to work. Therefore, it cannot be used with server-side libraries or with Engage.

Debounce Middleware is a Web action. The default Trigger is: type = "identify" or type = "group"

This action does not have any fields.

Identify User

Identifies an unidentified (alias-only) user. Use alongside the Create Alias action, or with user aliases you have already defined.

Identify User is a Cloud action.

Click to show / hide fields

Create Alias

Create new user aliases for existing identified users, or to create new unidentified users.

Create Alias is a Cloud action. The default Trigger is: event = "Create Alias"

Click to show / hide fields

Migration from Braze Classic

Keep the following in mind if you plan to move to Braze (Actions) from the classic Braze destination.

Braze-cloud settings mapping

braze-cloud Classic Destination Setting	How to enable in braze-cloud (Actions)
Connection Settings
App Identifier Cloud Device-web	This setting is not necessary in Braze Web Mode (Actions).
REST API Key Cloud	This setting is renamed API Key, and is available during initial configuration, or on the Settings tab after configuration.
Custom API Endpoint Device-web	This setting is not needed in Braze Web Mode (Actions).
Appboy Datacenter Cloud	This setting is covered by the REST API Endpoint
Log Purchase when Revenue is present Device-web	Modify the Trigger for the Track Purchase action to recreate this behavior in Braze (Actions). By default, events named “Order Completed” trigger this action, but you can update the Trigger to check for a property named revenue. The event must have a products array with product_id and price.
Custom REST API Endpoint Cloud	Select from the available REST Endpoints during initial configuration, or on the Destination’s Settings tab.
Safari Website Push ID Device-web	Available as a setting in Braze Web Mode (Actions)
Braze Web SDK Version Device-web	Hardcoded to version #.##
Connection Mode Cloud Device-web	Choose the version of the Braze (Actions) destination that matches your connection mode.
In-App Messaging
Enable Automatic In-App Message Registration Device-web	Unsupported, available only on Mobile.
Automatically send In-App Messages Device-web	Available as a setting in Braze Web Mode (Actions)
Do Not Load Font Awesome Device-web	Available as a setting in Braze Web Mode (Actions)
Enable HTML In-App Messages Device-web	Available as a setting in Braze Web Mode (Actions)
Open In-App Messages in New Tab Device-web	Available as a setting in Braze Web Mode (Actions)
Page
Track All Pages Device-web	Track Custom Event action Trigger the action on Page calls.
Track Only Named Pages Device-web	Track Custom Event action Trigger the action on Page calls where the name property exists.
Other Settings
Allow Crawler Activity Device-web	Available as a setting in Braze Web Mode (Actions)
Enable Logging Device-web	Available as a setting in Braze Web Mode (Actions)
Minimum Interval Between Trigger Actions in Seconds Device-web	Available as a setting in Braze Web Mode (Actions)
Only Track Known Users Device-web	Available as a setting in Braze Web Mode (Actions)
Open News Feed Cards in New Tab Device-web	Available as a setting in Braze Web Mode (Actions)
Session Timeout in Seconds Device-web	Available as a setting in Braze Web Mode (Actions)

Troubleshooting

Missing required fields

Braze requires one of either external_id, user_alias, or braze_id to be present in all events sent. If events are failing to send, please check your event mappings to make sure these fields are resolving to valid values.

Missing events

When an event is sent under an alias, the event may seem to be missing when the alias cannot be found in Braze. This may be due to incorrect search for the alias in Braze. To search for an alias in Braze, use the format “Alias Label:Alias Name”. For example, if the “Alias Label” field is set as email and “Alias Name” field is set as email address (for example: “test@email.com”), use “email:test@email.com” to search for the alias in Braze.