mParticle Android

This documentation explains how to send mParticle events to your Branch dashboard. If you'd like to send Branch installs to your mParticle dashboard, please review the Branch/mParticle Data Integration.


These instructions apply to the mParticle SDK version 5+ integration

mParticle introduced a new attribution & deep linking API in v5 of their SDK (, so please contact your Branch or mParticle Account Managers for more details, if you have mParticle SDK <v5 installed in your app.


Google Play Services version 17+

A major Google Play Services change made in June 2019 has caused Branch's Android SDK (and various other cross-platform SDKs, e.g. Unity) to stop collecting Android AID.

To ensure Branch deep linking and attribution continue to work, you must follow Google's update instructions here.

If you are running Google Play Services versions below 17, no update is necessary.

Technical Requirements

Branch Setup

Configure Branch & Enable App Links

1552 958
  • Add the following intent filter for the Branch URI scheme to the LauncherActivity in your Android Manifest
<!-- Branch URI Scheme -->
  <data android:scheme="androidexample" />
  <action android:name="android.intent.action.VIEW" />
  <category android:name="android.intent.category.DEFAULT" />
  <category android:name="android.intent.category.BROWSABLE" />
  • Add the following intent filter for the Branch domains to the LauncherActivity in your Android manifest
<!-- Branch App Links (optional) -->
<intent-filter android:autoVerify="true">
  <action android:name="android.intent.action.VIEW" />
  <category android:name="android.intent.category.DEFAULT" />
  <category android:name="android.intent.category.BROWSABLE" />
  <data android:scheme="https" android:host="" />
  <data android:scheme="https" android:host="" />
  • Add android:launchMode="singleTask" to the LauncherActivity
<!-- Launcher Activity to handle incoming Branch intents -->

    <action android:name="android.intent.action.MAIN" />
    <category android:name="android.intent.category.LAUNCHER" />
  • Make sure onNewIntent is setting a new intent every time your opens
public class LauncherActivity extends AppCompatActivity {
    public void onNewIntent(Intent intent) {
class LauncherActivity : AppCompatActivity() {

    public override fun onNewIntent(intent: Intent) {
        this.intent = intent

mParticle Setup

Enable Branch on mParticle

  • Before you can enable Branch in your mParticle dashboard, you must retrieve your Branch Key on the Link Settings page of your Branch dashboard.
  • Please follow mParticle's documentation on how to Connect an Event Output; i.e. enable the Branch integration.

Once you have added the kit and configured your branch API key in the mParticle dashboard, the mParticle SDKs will take care of initializing the Branch SDK and forwarding the appropriate application lifecycle events to handle deep links.

Install the mParticle Branch Kit

Import the Android Support Libraries

  • ''
  • ''
  • ''

Initializing Branch in the mParticle Kit

As with any kit, mParticle will automatically handle initializing Branch sessions. Please ensure mParticle.start() is called in your Android Application class (this should already be accounted for in your base mParticle integration).

At this point you should start seeing your Branch session data - including installs, re-opens, and any custom events - in your Branch dashboard.



[x] As with any attribution-related integration, be sure that you have added the mParticle ReferrerReceiver to your app’s AndroidManifest.xml

Retrieve Deep Link Data via mParticle

Our integration with mParticle supports the creation and attribution of deep links to install and open an app. A deep link will typically contain some additional information to be used when the user ultimately opens your application, so that you can properly route the user to the appropriate content, or otherwise customize their experience.

Please ensure you've followed mParticle's documentation to ensure your deep link data is being retrieved.


mParticle in React Native

If you integrate mParticle in React Native, you will still integrate the Branch kit as a Native module and follow the setup steps above. However, instead of retrieving deep link data in the the native layer, you'll retrieve deep link data via mParticle's React Native function found here.

Test deep link

  • Create a deep link from the Branch Dashboard
  • Delete your app from the device
  • Compile your app to your device
  • Paste deep link in Google Hangouts
  • Click on the deep link to open your app

Implementing Features

  • Please refer to mParticle's making direct calls to kits documentation for how to access the Branch kit via the mParticle SDK.
  • Direct calls to the Branch SDK will also require using .getAutoInstance(), rather than .getInstance().
  • Once you have a reference to the Branch kit, refer to Branch's native Android SDK documentation for how to implement secondary functionality.

Sample Testing Apps


Please refer to the Branch Android SDK troubleshooting section.