This guide will walk you through how to send your Branch data to Batch using Branch Data Integration.


Integrating the SDKs and tracking in-app events

The Branch SDKs for iOS and Android allow you to get up and running quickly.

If you haven't already integrated Branch SDK into your application, please follow our integration guide to integrate Branch SDK into your application:

  1. Documentation for Android

  2. Documentation for iOS

Limitations with setDebug and seeing data in Branch

When integrating the SDKs, it's often useful to use setDebug to verify that your app is able to communicate with Branch servers, and is receiving deep link data. However, our upstream systems don't register test events sent using setDebug, so events will not appear in Liveview or Analytics, nor will they fire postbacks. You should disable setDebug when looking at Liveview or testing postbacks.

Enable the integration

  1. Visit the Data Integration on the Branch dashboard.
  2. Search for your Data Integration Partner
  3. Select your Data Integration Partner
  4. Provide the required details
  5. Click Enable

Provide account credentials

Enter any credentials that may be required, and click Save and Enable in the bottom right hand corner.

Account credentials

You will find both keys in your dashboard settings.⚙ Settings → General.


To be able to match events with your users - you must send a Batch User ID using batch_user_id metadata key in via .setRequestMetaData

You can find more about Custom user ID here: https://doc.batch.com/ios/custom-data/customid#setting-up-a-custom-user-id

What Branch sends to Batch

  • Custom Event
  • Commerce Events

Updated 29 days ago


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.