Search specific term/phrase surrounded by double quotes. e.g. “deep linking”
Exclude records that contain a specific term prefixed with a minus. e.g. Android -Firebase


Connect Branch and Batch to unlock a more holistic picture of the customer journey for your app.


Overview is an SDK and marketing automation dashboard focused on marketing and transactional push notifications. It also includes mobile analytics which are useful to monitor and improve its users? customer retention as well as engagement.

How does it work?

Once the Branch SDK is integrated into an app, Branch can detect which Branch Links are leading to installs, re-opens, and users' actions. Enabling this integration and providing your relevant Ids will result in Branch automatically forwarding referred events to Batch, in the exact format Batch expects.

Branch Events Sent to Batch

The events Branch sends to third party data tools varies based on the events the partner supports as well as whether or not you've implemented the Branch SDK to measure said events.

Batch supports the following events:

  • Commerce Events
  • Custom Events


In order to enable Batch, you need to have completed the following:

  1. Admin access to your Branch Dashboard.
  2. Enabled Data Feeds for your Branch account.
  3. Implemented the Branch SDK into your mobile app (iOS | Android)
  4. Implement the Batch SDK
  5. Admin access to your Batch account.

Enable Batch

1. Retrieve IDs from Batch

Before you can enable the integration in your Branch dashboard, you need to retrieve your credentials from your Batch account.

Branch requires these credentials to not only authenticate, but to ensure your Branch data is being sent to the correct account.

Branch requires the following credentials:

  • REST API Key
  • iOS API Key
  • Android API Key

Please refer to Batch's documentation on how to retrieve these keys.

2. Connect Batch in Branch

In the Branch Dashboard in Data Feeds → Data Integrations tab, find and search for Batch.

Enter the API Keys from the previous step and hit Save.


3. Pass Metadata to the Branch SDK


Developer Required

Developers on your mobile app are required for this step

Batch requires you to pass through the correct identifiers to the Branch SDKs. In order to do so, retrieve the ID from the Batch SDK and pass this value to Branch using the following method:

  • setRequestMetadataKey() method of the Branch SDKs: iOS | Android



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:

4. Verify Data Sent

Once the above steps are complete, you are now ready to start launching campaigns. Branch-attributed conversions will be sent to Batch. To verify data is being sent from Branch to Batch, you can look at the Branch Dashboard's Liveview Webhook Records and apply the following filter:

webhook partner keyequalsdi_batch


Wait Period

Please be patient as data may take some time to flow through Branch's attribution systems and onto Batch. If data has not appeared in Batch after 30 minutes of completing a test conversion, review the above steps to see if you may have missed something.