Using Branch

Airship

Overview

AirshipAirship

Airship creates deeper connections with customers by delivering incredibly relevant, orchestrated messages on any channel.

EVENTS SENT TO DATA PARTNER

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.

Airship supports the following events:

  • Commerce Events
  • Custom Events

1. Complete Data Integration Prerequisites

🚧

DEVELOPER REQUIRED

BRANCH

Airship

2. Retrieve Keys/Credentials from Your Partner

Before you can enable the integration in your Branch dashboard, you need to retrieve your credentials from your Airship 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:

  • Airship Project Domain
  • Application Key
  • Access Token

Please refer to Airship's documentation if you need instructions on how to find the values required to enable the integration.

Enable the Integration

  1. In the left-hand navigation, under the Exports section, click Data Feeds.
  2. On the Data Feeds Manager page, click the Data Integrations tab at the top.
  3. Search for and click on your data partner.
  4. Provide the necessary credentials on the data partner's Export page.
  5. Click Enable.

4. Pass ID/Metadata to Branch

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

  • setRequestMetadataKey() method of the Branch SDKs: 
"Branch.getInstance().setRequestMetadata(""$braze_install_id"", Appboy.getInstance(this).getInstallTrackingId());

❗️

IMPORTANT

To be able to match events with your users - you must send a client's email using $airship_user_id metadata key in via .setRequestMetaData