Branch.io is an industry leader in cross-platform attribution, mobile app measurement, and deep linking. Many top-ranking apps use Branch to increase their performance and revenue through better performance and engagement.

RudderStack supports sending events from RudderStack SDKs to Branch through our data plane via the S2S (Server to Server) connection mode. You can also opt for the device mode as well for Android and iOS. Branch SDK is wrapped inside Rudder SDK in case of device mode.

Getting started

Before getting started, please determine whether the platform you are sending your event data from is supported. Refer to the following table for more the supported source types and connection modes:

In order to start sending data to Branch, you will first need to add it as a destination to the source from which you are sending the event data.

• Once you have added the source, you will need to register on Branch and follow the required steps to complete the set up.
• You should then be able to access the Branch key from the settings page of your Branch dashboard.
• Enter your Branch key to complete the destination configuration as shown:

BranchIO Dashboard Settings

Adding device mode integration

Depending on the platform of integration follow the steps below to integrate with Device-mode.

Now follow the instructions below to send events to Branch.

Identify

The identify call associates a user to their actions and also captures the traits associated with that user. Some of captured information includes a unique user ID, as well as optional traits such as name, email, IP address, etc.

A sample identify call captured from the RudderStack iOS SDK would look like the following:

Copy
[[RudderClient sharedInstance] identify:@"developer_user_id"
                                 traits:@{@"foo": @"bar", @"foo1": @"bar1"}];

Track

The track call captures all the activities that the user performs, along with any other properties that are associated with those activities. Each of these activities or actions is considered by RudderStack as an event.

A sample track call looks like the following:

Copy
[[RudderClient sharedInstance] track:@"test_event"
                          properties:@{@"key":@"value", @"foo": @"bar"}]

For example, consider the following code snippet for a track event Product Added from your JavaScript SDK:

Copy
rudderanalytics.track('Product Added', {
  cart_id: '1234',
  products: [
    {
       product_id: 'mobi1',
       name: "mobile name",
       brand: "brand name",
       variant: "4gb/8gb",
       price: "750$",
       quantity: "1",
       description: "Mobile phone description goes here",
    },
    {
       product_id: 'mobi2',
       name: "mobile name",
       brand: "brand name",
       variant: "16gb/32gb",
       price: "1000$",
       quantity: "1",
       description: "Mobile phone description goes here",
    }
  ]
});

All the trackable events in RudderStack are divided into three major Branch event categories:

• Commerce Events
• Content Events
• Lifecycle Events

The following table lists the mapping between the accepted names of the E-commerce events:

The following table lists the mapping between the accepted names of the Content events:

RudderStack also supports mapping the following events even though they are not explicitly a part of the RudderStack Lifecycle Events:

The following table lists the mapping of the accepted property keys common to all events:

FAQs

Where can I get the Branch Key from?

You can retrieve the Branch key from the settings page of the Branch dashboard. For more information, please check the Getting Started section above.

Contact us

For queries on any of the sections covered in this guide, you can contact us or start a conversation in our Slack community.