Braze is a customer engagement platform that helps you better understand your customers’ in-app behavior and use the insights to improve your users’ app experience.
Find the open-source transformer code for this destination in the GitHub repository.
Getting started
RudderStack supports sending event data to Braze via the following connection modes:
Connection Mode
Web
Mobile
Server
Device mode
Supported
Supported
-
Cloud mode
Supported
Supported
Supported
In a web device mode integration, that is, using JavaScript SDK as a source, the Braze native SDK is loaded from https://js.appboycdn.com/ domain. Based on your website’s content security policy, you might need to allowlist this domain to load the Braze SDK successfully.
Once you have confirmed that the source platform supports sending events to Braze, follow these steps:
From your RudderStack dashboard, add a source. Then, from the list of destinations, select Braze.
Assign a name to the destination and click Continue.
Connection settings
To successfully configure Braze as a destination, you need to configure the following settings:
App Key: Enter your Braze app key. For more information on obtaining your Braze app key, refer to the FAQ section below.
REST API Key: Enter the REST API key associated with your project. For more information on obtaining this key, refer to the FAQ section below.
When creating a new Braze Rest API Key for your app, you only need to select the users.track, users.identify, and users.alias.new endpoints under the User Data permissions.
Data Center: Specify the data center associated with your Braze account. The easiest way to get your data center details is to log in to your Braze account and observing your URL. Some examples are shown below:
For more information on getting your data center instance, refer to the Braze instances page.
Track events for anonymous users: Enable this setting to track anonymous user activity and send this information to Braze.
Enable subscription groups in group call: Enable this setting to send the subscription group status in your group events. For more information, refer to the Group section below.
The following settings are applicable only if you’re sending events to Braze via device mode:
Client-side Events Filtering: This setting lets you specify which events should be blocked or allowed to flow through to Braze. For more information on this setting, refer to the Client-side Events Filtering guide.
Use device mode to send events: Enable this setting to send events to Braze via device mode.
Deduplicate Traits: Enable this setting to deduplicate the user traits in the identify call.
Show Braze logs: Enable this setting to show the Braze logs to your users.
OneTrust Cookie Categories: This setting lets you associate the OneTrust cookie consent groups to Braze.
Adding device mode integration
Depending on your platform of integration, follow the steps below to add Braze to your project:
Follow these steps to add Braze to your iOS project:
Open the Podfile of your project and add the following line:
pod'Rudder-Braze'
Run the pod install command.
Change the SDK initialization to the following snippet:
If you are sending events to Braze via device mode, you can save on costs by deduplicating your identify calls. To do so, enable the Deduplicate Traits dashboard setting. RudderStack then sends only the changed or modified attributes (traits) to Braze.
It is highly recommended to review Braze’s data points policy to fully understand how this functionality can help you avoid data overages.
Track
The track call lets you record the customer events, that is, the actions that they perform, along with any properties associated with them.
Once you send a group event, RudderStack sends a custom attribute to Braze with the name as ab_rudder_group_<groupId> and the value as true. For example, if the groupId is 123456, then RudderStack creates a custom attribute with the name ab_rudder_group_123456 and sends it to Braze with its value to true.
While using the Braze destination in cloud mode, you can also update the subscription group status. To do so, enable the Enable subscription groups in group call setting in the RudderStack dashboard and send the subscription group status in the group call:
Either the email or phone is mandatory to send the subscription group in a group call.
Nested array operations
You can send the user traits to Braze as nested arrays via the identify or track calls and perform add, update, and remove operations on them. To do so, you must first enable the Nested Array Operations dashboard setting.
You can send the user traits via the identify call as follows:
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.