The Branch partnership with Braze provides a way to deliver Branch installs and attributions to your Braze dashboard. This allows you to analyze your users coming in from Branch deep linked campaigns.
How it works¶
We have built a custom integration to automatically send all Branch install data to Braze.
How do we differentiate Braze and Branch installs?
We rely on a Branch link being clicked, which leads to an install. This sets an internal boolean that an install came from Branch.
- This guide requires you to have already integrated the Branch mobile SDKs into your app.
- You also need to sign up for a Braze account and install the Braze SDK.
- Ensure Braze's iOS SDK is collecting the IDFA.
- Make sure to follow the steps in Braze's documentation here.
Get the Braze API key¶
- On the Braze dashboard, navigate to the App Settings section, and click 3rd Party Integrations.
- From there, grab your API key (this will be the same for all attribution partners listed on the page).
Configure the Branch Dashboard¶
Enable Data Feeds¶
Data Integrations are included as part of the Data Feeds product. For more information on Data Feeds, and how to enable it, please read the Data Feeds summary.
Select the integration¶
- Navigate to Data Integrations within Data Feeds.
Find the integration you need by typing in the search box.
We've upgraded our Data Integrations!
We've upgraded our Data Integrations to use people-based attribution. If you see the below screen instead of the screenshot above, please click
"Preview Now"to upgrade to our updated integrations. We will be deprecating our legacy integrations in 2018.
On the Branch Dashboard (dashboard.branch.io), navigate to the Integrations page.
- Search for Braze and click on the tile.
Enter your Braze API Key and hit
Please test integration!
Branch is not responsible for inaccurate API keys.
Pass Braze Android Install Tracking ID¶
When you're ready to send data through Branch, you'll need to make sure to pass through the Braze Android Install Tracking ID to the Branch SDKs. In order to do so, retrieve the ID from the Braze SDK and pass this value through
setRequestMetadataKey on the Branch SDKs.
Here's a sample snippet showing this. NOTE This is only required for Android. You must set the correct key before calling
Before you initialize in your Application#onCreate or Deep Link Activity's #onCreate.
Branch.getInstance().setRequestMetadata("$braze_install_id", Appboy.getInstance(this).getInstallTrackingId()); ... Branch.initSession(...);
In the above snippet,
this is the Activity context.
What Branch sends to Braze¶
|Branch Analytics Tag||Braze Data Placeholder Tag|
By default, Branch uses the new Braze endpoint https://rest.iad-01.braze.com. If your Braze app is using a different Braze endpoint please contact your Branch account manager or reach out to us at email@example.com. If you are not sure what endpoint your app uses please open a support ticket with Braze or use the Braze REST Endpoint table to find your correct REST endpoint.