Braze Destination Setup Guide

Set up and configure Braze as a destination in RudderStack.

  •   4 minute read  

This guide will help you set up Braze as a destination in the RudderStack dashboard. It also lists the configuration settings required to correctly send data from the supported sources to Braze.

Connection compatibility

Destination Information
  • Status: Generally Available
  • Supported sources: Android (Java) , Android (Kotlin) , iOS (Obj-C) , iOS (Swift) , Web, Unity, AMP , Cloud, Warehouse, React Native , Flutter, Cordova, Shopify
  • Refer to it as Braze in the Integrations object.
Connection Modes
SourceCloud modeDevice modeHybrid mode
AMPsupportednot supportednot supported
Android (Java)supportedsupportedsupported
Android (Kotlin)supportedsupportedsupported
Cloudsupportednot supportednot supported
Cordovasupportednot supportednot supported
Fluttersupportedsupportednot supported
iOS (Obj-C)supportedsupportedsupported
iOS (Swift)supportedsupportedsupported
React Nativesupportedsupportednot supported
Shopifysupportednot supportednot supported
Unitysupportednot supportednot supported
Warehousesupportednot supportednot supported
Websupportedsupportedsupported
Supported Message Types
SourceIdentifyPageTrackScreenGroupAliasRecord
Cloud mode
Supported sourcessupportedsupportedsupportedsupportedsupportedsupportednot supported
Device mode
Android (Java)supportednot supportedsupportednot supportednot supportednot supportednot supported
Android (Kotlin)supportednot supportedsupportednot supportednot supportednot supportednot supported
Fluttersupportednot supportedsupportednot supportednot supportednot supportednot supported
iOS (Obj-C)supportednot supportedsupportednot supportednot supportednot supportednot supported
iOS (Swift)supportednot supportedsupportednot supportednot supportednot supportednot supported
React Nativesupportednot supportedsupportednot supportednot supportednot supportednot supported
Websupportedsupportedsupportednot supportednot supportednot supportednot supported
info

In the web device mode integration, that is, when using JavaScript SDK as a source, RudderStack loads the Braze native SDK from the 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.

Setup

  1. In your RudderStack dashboard, set up a source.
  2. Go to the Overview tab of your source and select Add Destination > Create new destination.
Add new destination in RudderStack dashboard
  1. Select Braze from the list of destinations. Then, click Continue.

Connection settings

SettingDescription
Destination nameAssign a name to uniquely identify the destination.
Default API KeyEnter your Braze default API key.
REST API KeyEnter the REST API key associated with your project.

Note: When creating a new Braze Rest API Key for your app, make sure to select the following permissions:

PermissionDescription
users.trackFor creating/updating users and registering events.
users.identifyFor identity resolution of identified and anonymous users.
users.deleteFor deleting users.
users.alias.new and users.mergeFor aliasing users.
users.export.idsFor deduplication.
Data CenterSpecify the data center associated with your Braze account. See Supported Braze data centers for more information.

Note: To get your data center details, log in to your Braze account and note your URL.

Supported Braze data centers

Data center regionDashboard URL
Australiahttps://dashboard.au-01.braze.com
Europehttps://dashboard-01.braze.eu
https://dashboard-02.braze.eu
UShttps://dashboard-01.braze.com
https://dashboard-02.braze.com
https://dashboard-03.braze.com
https://dashboard-04.braze.com
https://dashboard-05.braze.com
https://dashboard-06.braze.com
https://dashboard-07.braze.com
https://dashboard-08.braze.com

Event settings

SettingDescription
Enable subscription groups in group callTurn on this setting to send the subscription group status in your group events.

Note: This setting is available only in cloud mode.
Use Custom Attributes OperationTurn on this setting to use Braze’s nested custom attributes functionality to create segments and personalize your messages using a custom attribute object. For more information, see Send user traits as nested custom attributes.

Note: This setting is available only in cloud mode.

Deduplication settings

SettingDescription
Deduplicate TraitsTurn on this setting to enable traits deduplication for the identify and track calls.

Web SDK settings

Configure the following settings to send events to Braze in web device mode:

SettingDescription
Show Braze logsTurn on this setting to show Braze logs to the customers.
Use web push notificationsTurn on this setting to use push notifications for web.

Note: This feature requires you to set up a service worker on your site.
Enable HTML in-app messagesTurn on this setting to enable HTML in-app messages.
Track events for anonymous usersTurn on this setting to track anonymous user activity and send this information to Braze.

Other settings

SettingDescription
Client-side Events FilteringThis setting lets you specify which events should be blocked or allowed to flow through to Braze. For more information on this setting, see Client-side Events Filtering.
OneTrust Cookie CategoriesThis setting lets you associate the OneTrust cookie consent groups to Braze.

Next steps

FAQ

Where can I find the Braze Default API Key?

  1. Log in to your Braze dashboard.
  2. Go to Settings > APIs and Identifiers.
  3. Go to the App Identifiers section:
Braze Default API Key
  1. The Default API Key for your specific app is listed here.
Braze Default API Key

Where can I find the Braze REST API Key?

  1. Log in to your Braze dashboard.
  2. Go to Settings > APIs and Identifiers.
  3. Go to the API Keys section:
Braze REST API Key
  1. You can find the REST API Key for your workspace listed here.
Braze REST API Key

Questions? Contact us by Email or on Slack