Branch is a mobile measurement and deep linking platform that helps acquire and engage users efficiently across all devices, channels, and platforms. This document provides information about integrating Branch and CleverTap. This integration helps track the following information from Branch:

  • Install events: These events can be organic install events and inorganic install events.
  • Custom Events: These events can include any events (other than install events) that are provided by the attribution partner or tracked in the app. The following events are tracked for Branch: Lifecycle events, Commerce events, and Content events. For more information about each event, refer to Branch documentation.

To learn more about these events and their default attribution settings in the CleverTap dashboard, refer to Types of Data.

Integrating Branch

To enable Branch integration with the CleverTap dashboard, proceed as follows:

  1. Add CleverTap Credentials to Branch Dashboard.
  2. Integrate Branch.
  3. Setup for Organic Install and Custom Events.

Add CleverTap Credentials to Branch Dashboard

To activate integration with CleverTap from the Branch dashboard, follow the steps listed under CleverTap integration with Branch section of Branch documentation.


Add CleverTap Credentials to Branch Dashboard



In the above figure, enter the region of your CleverTap account. The following table helps identify the region of your account:

Integrate Branch

The integration steps vary for Android and iOS. The steps for both are listed below.

For Android App

  1. To track attribution and events data in your Android app, perform the steps listed in Branch Android SDK Integration Guide.
  2. Add the following code to your Android app code before ​you ​initialize ​onCreate() or Deep ​Link ​Activity’s onCreate() in ​your application:

For SDK version 4.2.0 and above
The getCleverTapAttributionIdentifier method is deprecated for CleverTap Android SDKs version 4.2.0 and above. Use the new getCleverTapID method to get the CleverTap ID on the OnInitCleverTapIDListener to set CustomerUserId method of Branch.

cleverTapInstance.getCleverTapID(new OnInitCleverTapIDListener() {
   public void onInitCleverTapID(final String cleverTapID) {
   // Callback on main thread
   Branch branch = Branch.getInstance();
cleverTapInstance?.getCleverTapID {
// Callback on main thread


SDK version 4.1.1 and below

Branch branch = Branch.getInstance();

For iOS App

To integrate Branch with CleverTap for an iOS app:

  1. To track attribution and events data in your iOS app, perform the steps listed in Branch iOS SDK Integration Guide.
  2. Add the following code inside didFinishLaunchingWithOptions of iOS app code:
Branch *branch = [Branch getInstance];
[CleverTap autoIntegrate];
[[Branch getInstance] setRequestMetadataKey:@"$clevertap_attribution_id"
value:[[CleverTap sharedInstance] profileGetCleverTapAttributionIdentifier]];
if let branch = Branch.getInstance() {
value:CleverTap.sharedInstance()?profileGetCleverTapAttributionIdentifier() as

Setup for Organic Install and Custom Events

After successful integration, the Branch starts pushing inorganic install events data to CleverTap. To receive additional events, proceed as follows:

  1. Navigate to Settings > Partners and scroll down to the Attribution partners section.

CleverTap Attribution Partners

  1. Click the Edit icon against the Branch partner.
    The Attribution partner - Branch popup appears on the right side of the screen.

Attribution Partner - Branch

  1. Select Custom events to accept this event data when shared by the partner.
  2. Click Save. On clicking, the following message displays at the top of the screen: Changes saved. Admins are notified of this via email.

Viewing Data in Dashboard

You can now view the event data on the CleverTap dashboard. To do so, proceed as follows:

  1. From the CleverTap dashboard, navigate to Analytics > Events.
  2. Apply the required filters for the selected event. The filters vary depending on the type of event.
  • For Install Events: All the install events are tracked under the UTM Visited event.

Filter Install Events

  • For Custom Events: Lifecycle events, Commerce events, Content events, and Custom events received from Branch are prefixed with BR in CleverTap.