Braze (formerly Appboy) is a network partner.

Module partners can use additional and extended data from adjust, and have been integrated with a custom module in adjust's backend. This guide describes how to activate the Braze (formerly Appboy) module, as well as additional set up that may be required or beneficial.

To integrate Braze (formerly Appboy) with adjust, follow these steps:

  1. Activate the module by adding one or more tokens in the Braze (formerly Appboy) panel in your dashboard.
  2. Optionally, add event labels to your in-app events in your Braze (formerly Appboy) panel to send in-app events to Braze (formerly Appboy).
  3. Update your SDK to send certain partner parameters. This may be mandatory.
  4. Create a tracker for Braze (formerly Appboy) and use this as the destination of your ads.
  5. All set - adjust will transmit the requisite data to Braze (formerly Appboy).

1Activating the Braze (formerly Appboy) module

All settings related to Braze (formerly Appboy) can be found in your dashboard. Simply open your app settings and follow through to Partner Setup > Add Partners > Braze (formerly Appboy).

To activate the integration, enter your Install API Key, Event API Key and Endpoint (see note) within this panel. You can find the required values in your Braze (formerly Appboy) dashboard.

Once activated, adjust will automatically start sending install and (when activated) event callbacks to Braze (formerly Appboy).

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. To send event callbacks to Braze, you must implement external_id as an event partner parameter within the Adjust SDK. 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.

1.1Forwarding events to Braze (formerly Appboy)

You can also choose to transmit in-app events to Braze (formerly Appboy). Each in-app event can be activated separately, so as to give you complete control of the data that you're sharing with your partners.

  1. Open the Braze (formerly Appboy) panel in your app settings.
  2. Select Event Linking and enter a name for each event you want to transmit to Braze (formerly Appboy). This is the name that will be shown in their interface. You can use the same names as you do in adjust, if you wish.
    If you want to transmit all events to Braze (formerly Appboy) with the same names as you have set up in adjust, you can hit the "Fill all with event names" button.
    You also have the option use the same name for multiple events. If you do decide on doing this, it will result in those events displaying as a single event type in the Braze (formerly Appboy) interface.
  3. As soon as you save these updated settings, adjust will start transmitting the in-app events that you have configured.

1.2List of parameters transmitted to Braze (formerly Appboy)

Braze (formerly Appboy) require certain parameters to be passed to them via their module. When you activate their module, the following parameters will be automatically transmitted.

  • Raw device IDs
  • Partial tracker names
  • App metadata
  • Timestamps
  • All partner parameters (if you activate them)
  • Revenue data (if you activate it)

2Creating tracker URLs for Braze (formerly Appboy)

Braze (formerly Appboy) uses standard tracker URLs. You can simply create a tracker in your adjust dashboard, and then use the tracker URL directly as the destination of your ads with Braze (formerly Appboy).

For more details on creating tracker URLs, please check out the tracker generation guide.

3Sending partner parameters to Braze (formerly Appboy)

Braze (formerly Appboy) 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 (formerly Appboy). 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 (formerly Appboy) 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

When sending events, you should append 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. Finally, you should implement braze_device_id as both a session and event partner parameter (Android only) in order to send Android callbacks.