Set up Braze

Braze is an an analytics and ad network integrated with Adjust. Our integration lets Braze receive attribution and in-app event data through automated callbacks.

In this article, learn how to set up measurement with Braze for your app. This includes activating the integration, sending callbacks to Braze, and choosing what data Adjust can share with Braze.

Before you begin


iOS / Android / Windows / Unity / React Native / Flutter / Adobe Air / Cordova / Marmalade / Xamarin / Cocos2d-x / Titanium / Corona

In the Braze dashboard

Before you activate Adjust's integration with Braze, you need to complete the following steps:

1. Map device IDs


If you have an Android app, you need to pass a unique Braze device ID to Adjust. Use the addSessionPartnerParameter() method in the Adjust SDK to set this value. You need to include this code snippet before initializing the Braze Android SDK on Adjust.onCreate().

Adjust.addSessionPartnerParameter("braze_device_id", Braze.getInstance(getApplicationContext()).getDeviceId()););



Adjust collects the IDFV for your iOS app and sends it to Braze. Braze then maps this ID to a unique device ID.

Braze stores IDFA values for users that have opted-in if you are collecting the IDFA with Braze. Otherwise, the IDFV is used as a fallback identifier to map users.


If you have an iOS app, you may opt to collect the IDFV by setting the useUUIDAsDeviceId field in the Braze Swift SDK to false. If not set, iOS attribution will not map accurately from Adjust to Braze. For more information, refer to Collecting IDFV in Braze documentation.

2. Generate the Braze data import key

  1. In Braze, navigate to Technology Partners and select Adjust.
  2. Here, you will find the REST Endpoint and generate your Braze Data Import Key.

Once generated, you can create a new key or invalidate an existing one. Use the data import key and the REST endpoint to configure Adjust's integration with Braze. For more information, see Braze documentation.

Select Braze and your app in Campaign Lab

  1. Under Campaign Lab, select Partners.
  2. Select New partner > Braze. Select Next to move to the next screen.
  3. In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with Braze.
  4. Select Next.

Enable data sharing

Enable data sharing to activate the integration with Braze. To enable data sharing:

  1. Enter your Data import key and and Endpoint.

Once you enable data sharing with {DisplayName}, Adjust automatically sends {DisplayName} the following data, by default:

  • Installs

Note: Once Braze receives data about an attributed install from Adjust, the status connection indicator on the Adjust technology partners page in Braze changes from “Not Connected” to “Connected”. A timestamp of the last successful request is also included.

Set your data sharing options

If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:

  1. Separate data sharing options at the platform-level by selecting Use platform-specific settings.
  2. Set the same data sharing settings for multiple platforms by selecting Use global settings.

Now, under What will be shared by default?, review the activities that Adjust shares with Braze by default.

  • Installs

Send additional data

Choose the amount and type of data that you want to share with Braze through callbacks. Braze may use this information to optimize performance.

In-app revenue (from in-app purchases)

Sharing in-app revenue lets Braze receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.

Map parameters

You usually need to map parameters to share custom data with Braze.

Map events

Map events that you want to share to the values that Braze can receive. Data for unmapped events is not shared with Braze.

Under Map events, follow these steps to choose the in-app events you want to directly send to Braze.

  1. Select Map event.
  2. In the Adjust event list, choose the Adjust event that you want to share with Braze.
  3. In the Partner event list, choose or enter a custom event name that you want to map the Adjust event to. You might have to map an event to several values.
  4. Select Apply.

Now Braze will receive in-app event data for each of your linked events.

Map parameters

Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Braze. This lets Braze receive custom event details for each of your linked events.

Before adding new partner parameters to the Adjust SDK, make sure no pre-existing partner parameters already fit your requirements.

To share partner parameters to Braze, follow these steps.

  1. Set up partner parameters within the Adjust SDK: iOS, Android
  2. Check the Parameters data sharing checkbox.
  3. Map your events.

If you set up partner parameters within the Adjust SDK without setting up parameter sharing in the dashboard, Adjust forwards the parameters as named in the Adjust SDK.

Enable Braze for your app

In the Setup review screen, you can review your choices. You can also go back and make changes to:

  • Your selected app
  • Data sharing options

Select Enable partner to enable Braze for your app. Analytics partners don't work with links for campaigns. Once enabled, our integration sends attribution and in-app event data via automated callbacks.

Partner specific setup instructions

Note: The Endpoint protocol should not be entered; so please ensure that you do not include https:// in the activation field. Last but not least, be aware that Braze requires specific parameters in order to receive callback data.

Predefined parameters

Braze allows you to send a set of predefined parameters. If you attach any of these parameters to an event in your adjust SDK, these will be forwarded to Braze. You can find out more about attaching partner parameters in the SDK readme specific to the SDK or SDKs you are working with. Below is a list of the defined parameters that Braze accepts:

Parameter key > Value

  • external_id > mandatory for sending events to Braze.
  • braze_device_id > mandatory for sending any Android data to Braze.
  • product_id > mandatory for sending revenue events to Braze.

To send event callbacks to Braze, you must implement external_id as an event partner parameter within the Adjust SDK. For revenue event forwarding, you should also set up product_id as a partner parameter for events.

For Android apps, you must also implement braze_device_id as both a session and event partner parameter. Finally, for revenue event forwarding, you must also set up product_id as a partner parameter for revenue events. Please note that Braze does not support Organic, Facebook, or Twitter data so callbacks for these campaigns will not be sent.

Currently Adjust does not forward Organic, Facebook, and Twitter campaign data to Braze.

If you would like to find out more about how to leverage this integration for your use cases, check out our one pager with Braze . In case of any questions related to the information provided on the one pager, please reach out to .

List of all parameters forwarded to Braze

Braze requires Adjust to send the following parameters (data points) with your callbacks:

{currency}Original ISO 4217 currency code sent from Adjust SDK
{idfa}ID for advertisers (iOS only)
{partner_parameters}Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks
{revenue}Revenue, as sent from Adjust SDK in cents
{win_adid}Windows advertising identifier
{adgroup_name}Adgroup name
{app_id}Store App ID or Google Play Store
{campaign_name}Campaign name
{created_at}Activity timestamp
{creative_name}Creative name
{network_name}Network name