Set up Braze

Braze is an analytics partner integrated with Adjust. Our integration lets Braze receive data measured in Adjust through automated callbacks. Use this data with the partners' tools for analytics and insights.

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

Before you begin

Requirements

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

Credentials

INSTALL API KEY, EVENT API KEY, and ENDPOINT

  • For help finding your credentials, contact your Braze representative.

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 INSTALL API KEY, EVENT API KEY, and ENDPOINT.

Once you enable data sharing with Braze, Adjust automatically sends Braze the following data, by default:

  • install
  • event

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:

  • install
  • event

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.

To send additional data, you can review and customize the following:

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.

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.
  2. Under Set your data sharing options, select Parameters.
  3. Under Map parameters, you can specify how you want to send partner parameters defined in the SDK to the network:
    1. Select Map parameter.
    2. In the SDK parameter field, enter the name of the SDK parameter you want to share with the network.
    3. In the Partner parameter field, enter the network parameter that corresponds to the SDK parameter.
Note:

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 trackers will not be sent.

Callbacks
Currently Adjust don't 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 partners@adjust.com .

List of all parameters forwarded to Braze

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

PlaceholderInformation
{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, as taken from the tracker
{app_id}Store App ID or Google Play Store
{campaign_name}Campaign name, as taken from the tracker
{created_at}Activity timestamp
{creative_name}Creative name, as taken from the tracker
{network_name}Network name, as taken from the tracker