Home
/
Connections
/
Destinations
/
Catalog
/
Braze Cloud Mode (Actions) Destination

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.

This document is about a feature which is in beta. This means that the Destination Actions are in active development, and some functionality may change before it becomes generally available

Good to know: This page is about the Actions-framework Braze Segment destination. There’s also a page about the non-Actions Braze destination. Both of these destinations receives data from Segment. There’s also the Braze source, which sends data to Segment!

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

From the Segment web app, click Catalog.
Search for “Braze” in the Catalog, select Braze Cloud Mode (Actions), and choose which of your sources to connect the destination to.
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.

Pre-built subscriptions

Subscription Name	Trigger	Braze Web Action
Track Calls	All track calls from the connected source, where the Event Name is not “Order Completed”	Track Event
Order Completed Calls	All track calls from the connected source, where the Event Name is “Order Completed”	Track Purchase
Identify Calls	All calls where the Event Type is Identify or Group	Update User Profile

Available Braze Actions

Build your own subscription. Combine the supported triggers with the following Braze-supported actions:

Track Event
Track Purchase
Update User Profile
Identify Debounce

Track Event

Track Event sends Braze a Track Event call when the destination receives a Track event that is not named Order Completed.

Click to expand fields

Field	Description
Event Name	Default `event` The name of the event that Braze receives.
Time	Default `receivedAt` The timestamp of when the event occured.
External User ID	Default `userId` The unique identifier of the user who performed the event.
User Alias Object	The user alias object. For more information, see the Braze documentation.
Braze User Identifier	Default `properties.braze_id` The unique identifier of the user that is passed to Braze.
Event Properties	Default `properties` The object that contains properties pertaining to the event.
Update Existing Only	Set to true to use the Braze API in “Update Only” mode.

Track Purchase

Track Purchase sends Braze a Track Purchase call when the destination recieves any event that matches the specified name.

Click to expand fields

Field	Description
Time	Default `receivedAt` The timestamp of when the event occured.
Products	Default `properties.products` A list of the products included in the order.
External User ID	Default `userId` The unique identifier of the user who performed the event.
User Alias Object	The user alias object. For more information, see the Braze documentation.
Braze User Identifier	Default `properties.braze_id` The unique identifier of the user that is passed to Braze.
Event Properties	Default `properties` The object that contains properties pertaining to the event.
Update Existing Only	Set to true to use the Braze API in “Update Only” mode.

Update User Profile

Update User Profile sends to Braze a request to update an existing user’s profile attributes when the destination receives an Identify call.

Click to expand fields

Field	Description
External User ID	Default `userId` The unique identifier of the user who performed the event.
User Alias Object	The user alias object. For more information, see the Braze documentation.
Braze User Identifier	Default `properties.braze_id` The unique identifier of the user that is passed to Braze.
Country	Default `context.location.country` The user’s country code.
Current Location	Default `\{"latitude":{"@path":"$.context.location.latitude"},"longitude":{"@path":"$.context.location.longitude"}}` The user’s lattitude and longitude when they complete the event.
Date of First Session	The date on which the user first used the application.
Date of Last Session	The date on which the user most recently used the application.
Date of Birth	The user’s date of birth.
Email	Default `traits.email` The user’s email address.
Email Subscribe	The user’s email subscription preference. Must be one of: `opted_in`, `unsubscribed`, or `subscribed`
Email Open Tracking Disabled	Set to true to disable adding the open tracking pixel to all future emails sent to this user.
Email Click Tracking Disabled	Set to true to disable click tracking for all links within future emails sent to this user.
Facebook Attribution Data	A hash of Facebook attribution data that contains any of `id`, `likes`, or `num_friends`
First Name	Default `traits.firstName` The user’s first name
Gender	Default `traits.gender` The user’s gender: `M`, `F`, `O` (other), `N` (not applicable), `P` (prefer not to say), or nil (unknown).
Home City	Default `traits.address.city` The user’s home city.
Image URL	Default `traits.avatar` The URL of the image associated with this user profile.
Language	The user’s preferred language.
Last Name	Default `traits.lastName` The user’s last name.
Marked Email as Spam At	The date on which the user marked their email as spam.
Phone Number	Default `traits.phone` The user’s phone number.
Push Subscribe	The user’s push subscription preference: `opted_in` (explicitly registered to receive push messages), `unsubscribed` (explicitly opted out of push messages), and `subscribed` (neither opted in nor out).
Push Tokens	An array of objects with app_id and token string. You can optionally provide a `device_id` for the device this token is associated with. For example,`{“app_id”: App Identifier, “token”: “abcd”, “device_id”: “optional_field_value”}. If a device_id is not provided, a random value is generated.
Time Zone	The user’s time zone from the IANA Time Zone Database. For example, `America/New_York`.
Twitter Attribution Data	A Hash that contains any of id, screen_name, followers_count, friends_count, and statuses_count.
Custom Attributes	Default `traits` A hash of custom attributes sent to Braze.
Update Existing Only	Default `true` Set this flag to true to put the API in “Update Only” mode.

Identify Debounce

When enabled for Javascript sources, this action ensure that only Identify calls where at least one updated trait value are sent to Braze. Events with duplicate traits are not sent. To use Identify Debounce with mobile sources, include Segment’s open-source Middleware tool.

This action does not have any 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

All Cloud Device-web

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)

This page was last modified: 31 Aug 2021

Need support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Was this page helpful?

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.

Create free account