Setup Guide

Set up and configure Braze as a destination in RudderStack.

  •   3 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 info
  • Status: Generally Available
  • Supported sources: Android, iOS , 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
Androidsupportedsupportedsupported
Cloudsupportednot supportednot supported
Cordovasupportednot supportednot supported
Fluttersupportedsupportednot supported
iOSsupportedsupportedsupported
React Nativesupportedsupportednot supported
Shopifysupportednot supportednot supported
Unitysupportednot supportednot supported
Warehousesupportednot supportednot supported
Websupportedsupportedsupported
Supported message types
SourceIdentifyPageTrackScreenGroupAlias
Cloud mode
Supported sourcessupportedsupportedsupportedsupportedsupportedsupported
Device mode
Androidsupportednot supportedsupportednot supportednot supportednot supported
Fluttersupportednot supportedsupportednot supportednot supportednot supported
iOSsupportednot supportedsupportednot supportednot supportednot supported
React Nativesupportednot supportedsupportednot supportednot supportednot supported
Websupportedsupportedsupportednot supportednot supportednot supported
Hybrid mode
Supported sourcessupportedsupportedsupportedsupportedsupportedsupported
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

In your RudderStack dashboard, add a source. Then, from the list of destinations, select Braze.

Connection settings

SettingDescription
Destination nameAssign a name to uniquely identify the destination.
App KeyEnter your Braze app 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.alias.new and users.mergeFor aliasing users.
users.export.idsFor deduplication.
Data CenterSpecify the data center associated with your Braze account.

To get your data center details, log in to your Braze account and note your URL. Some examples of identifying the Braze instance from the URL are shown:

URLData Center Instance
https://dashboard-01.braze.comUS-01
https://dashboard-03.braze.comUS-03
https://dashboard-01.braze.euEU-01

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.
Track events for anonymous usersTurn on this setting to track anonymous user activity and send this information to Braze.

Deduplication settings

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

Web SDK settings

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.

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 App Key and REST API Key?

  1. Log in to your Braze dashboard.
  2. Go to Settings > API Keys.

You can find the REST API key for your workspace under the REST API Keys section:

Braze REST API Key

You can find your Braze App Key in the Identification section:

Braze App Key

Questions? Contact us by email or on Slack