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 ModeWebMobileServer
Device modeSupportedSupported-
Cloud modeSupportedSupportedSupported
In a web device mode integration, that is, using JavaScript SDK as a source, the Braze native SDK is loaded from 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:

  1. From your RudderStack dashboard, add a source. Then, from the list of destinations, select Braze.
  2. 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 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.
  • Use Nested Array Operations: Enable this setting to use the nested array operations in your track calls.

Device mode settings

The following settings are applicable only if you're sending events to Braze via the 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 the 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:
  1. Open the Podfile of your project and add the following line:
    pod 'Rudder-Braze'
  2. Run the pod install command.
  3. Finally, change the SDK initialization to the following snippet:
    RudderConfigBuilder *builder = [[RudderConfigBuilder alloc] init];
    [builder withDataPlaneUrl:<DATA_PLANE_URL>];
    [builder withFactory:[RudderBrazeFactory instance]];
    [RudderClient getInstance:<WRITE_KEY>; config:[builder build]];
This device mode integration is supported for Braze v4.4.4 and above.
Follow these steps to add Braze to your iOS project:
  1. Install RudderBraze (available through CocoaPods) by adding the following line to your Podfile:
    pod 'RudderBraze', '~> 1.0.0'
  2. Run the pod install command.
  3. Then, import the SDK depending on your preferred platform:
    import RudderBraze
    @import RudderBraze;
  4. Next, add the imports to your AppDelegate file under the didFinishLaunchingWithOptions method, as shown:

    let config: RSConfig = RSConfig(writeKey: WRITE_KEY)
    RSClient.sharedInstance().configure(with: config)
    RSConfig *config = [[RSConfig alloc] initWithWriteKey:WRITE_KEY];
    [config dataPlaneURL:DATA_PLANE_URL];
    [[RSClient sharedInstance] configureWith:config];
    [[RSClient sharedInstance] addDestination:[[RudderBrazeDestination alloc] init]];
  5. To send the push notification events, refer to the Sending push notifications section below.
To add Braze to your Android project, follow these steps:
  1. Open your app/build.gradle (Module: app) file, and add the following:
    repositories {
    maven { url "" }
  2. Add the following under dependencies section:
    implementation '[1.0,2.0)'
    implementation '[1.0.7,)'
    implementation ''
  3. Add the following permissions to the AndroidManifest.xml file:
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  4. Finally, change the SDK initialization to the following:
    val rudderClient: RudderClient = RudderClient.getInstance(
To add Braze to your React Native project, follow these steps:
  1. Add the RudderStack-Braze module to your app by running the following command:
    npm install @rudderstack/rudder-integration-braze-react-native
    yarn add @rudderstack/rudder-integration-braze-react-native
  2. Open your android/build.gradle file (Project level), and add the following:
    repositories {
    maven { url "" }
  3. Import the module you added above and add it to your SDK initialization code as shown:
    import rudderClient from "@rudderstack/rudder-sdk-react-native"
    import braze from "@rudderstack/rudder-integration-braze-react-native"
    const config = {
    dataPlaneUrl: DATA_PLANE_URL,
    trackAppLifecycleEvents: true,
    withFactories: [braze],
    rudderClient.setup(WRITE_KEY, config)
Follow the below steps to add Braze to your Flutter Project:
  1. Add the following dependency to the dependencies section of your pubspec.yaml file.
    rudder_integration_braze_flutter: ^1.0.1
  2. Run the below command to install the dependency added in the above step:
    flutter pub get
  3. Import the RudderIntegrationBrazeFlutter in your application where you are initializing the SDK.
    import 'package:rudder_integration_braze_flutter/rudder_integration_braze_flutter.dart';
  4. Finally, change the initialization of your RudderClient as shown:
    final RudderController rudderClient = RudderController.instance;
    RudderConfigBuilder builder = RudderConfigBuilder();
    rudderClient.initialize(<WRITE_KEY>, config:, options: null);


You can use the identify call to identify a user in Braze in any of the following cases:

  • When the user registers to the app for the first time.
  • When they log into their app.
  • When they update their information.

A sample identify call is shown below:

"1hKOmRA4GRlm", {
email: "",
name: "Alex Keener"

Deleting a user

You can delete a user in Braze using the Suppression with Delete regulation of the RudderStack Data Regulation API.

To delete a user, you must specify their userId in the event. Additionally, you can specify a custom identifier (optional) in the event.

A sample regulation request body for deleting a user in Braze is shown below:

"regulationType": "suppress_with_delete",
"destinationIds": [
"users": [{
"userId": "1hKOmRA4GRlm",
"<customKey>": "<customValue>"

Delta management for identify calls

If you are sending events to Braze via the 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.


The track call lets you record the customer events, that is, the actions that they perform, along with any properties associated with them.

A sample track call is shown below:

rudderanalytics.track("Product Added", {
numberOfRatings: "12",
name: "item 1",

Order Completed

When you call the track method for an Order Completed event, RudderStack sends the product information present in the event to Braze as purchases.

A sample Order Completed event is shown below:

rudderanalytics.track("Order Completed", {
userId: "1hKOmRA4GRlm",
currency: "USD",
products: [{
product_id: "123454387",
name: "Game",
price: 15.99

Nested array operations

You can also send the track properties as nested arrays and perform create, add, update, and remove operations on them. To do so, you must first enable the Nested Array Operations dashboard setting. Then, include the field nestedOperationType in the track event, as shown:

rudderanalytics.track("Product Viewed", {
"nestedOperationType": "update",
"pets": [{
"identifier_key": "id",
"identifier_value": 4,
"new_object": {
"breed": "fish"
"identifier_key": "id",
"identifier_value": 5,
"new_object": {
"name": "alex"

Note that nestedOperationType is a required field for this feature and must take one of the create, update, add, or remove values.

For more information on sending nested custom attributes to Braze, refer to the Braze documentation.


The page call allows you to record your website's page views, with the additional relevant information about the viewed page.

A sample page call is as shown below:"Cart", "Cart Viewed", {
path: "/cart",
referrer: "",
search: "term",
title: "test_item",
url: "",


You can use the group call to link an identified user with a group, such as a company, organization, or an account."12345", {
name: "MyGroup",
industry: "IT",
employees: 450,
plan: "basic"

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, as shown:"12345", {
subscriptionState: "subscribed",
email: ""
Either the email or phone is mandatory to send the subscription group in a group call.

Sending push notification events

This feature is applicable only for the RudderStack iOS SDK v2.

For sending the push notification events, add the following code to your AppDelegate file under the didFinishLaunchingWithOptions method:

if #available(iOS 10, *) {
let center = UNUserNotificationCenter.current()
center.delegate = self
var options: UNAuthorizationOptions = [.alert, .sound, .badge]
if #available(iOS 12.0, *) {
options = UNAuthorizationOptions(rawValue: options.rawValue | UNAuthorizationOptions.provisional.rawValue)
center.requestAuthorization(options: options) { (granted, error) in
} else {
let types: UIUserNotificationType = [.alert, .badge, .sound]
let setting: UIUserNotificationSettings = UIUserNotificationSettings(types: types, categories: nil)
if (floor(NSFoundationVersionNumber) > NSFoundationVersionNumber_iOS_9_x_Max) {
UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
center.delegate = self;
UNAuthorizationOptions options = UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
if (@available(iOS 12.0, *)) {
options = options | UNAuthorizationOptionProvisional;
[center requestAuthorizationWithOptions:options
completionHandler:^(BOOL granted, NSError * _Nullable error) {
[[RSClient sharedInstance] pushAuthorizationFromUserNotificationCenter:granted];
[[UIApplication sharedApplication] registerForRemoteNotifications];
} else {
UIUserNotificationSettings *settings = [UIUserNotificationSettings settingsForTypes:(UIUserNotificationTypeBadge | UIUserNotificationTypeAlert | UIUserNotificationTypeSound) categories:nil];
[[UIApplication sharedApplication] registerForRemoteNotifications];
[[UIApplication sharedApplication] registerUserNotificationSettings:settings];


Where can I find the Braze App Key and REST API Key?

To obtain your Braze App Key and REST API Key, follow these steps:

  1. Log into your Braze dashboard.
  2. Go to Settings > Developer Console.
  3. You can find the REST API key for your app under the Identifier column, as shown:
Braze REST API Key
  1. You can find your Braze App Key in the Identification section, as shown:
Braze App Key

Contact us

For more information on the topics covered on this page, email us or start a conversation in our Slack community.