Airship Configuration (New)

Overview

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

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 Airship, in the exact format Airship expects.

Branch events sent to Airship

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

Before you begin

To set up the Airship integration, you first need to:

 

1. Admin access to your Branch account.

 

2. Have the Advanced Data Feeds add-on enabled on your Branch account. Advanced Data Feeds can be included as an add-on to both the Engagement and Performance products.

 

3. Implemented the Branch SDK into your mobile app (iOS | Android)

      
        

   • Track events

      
    
 

4. Implement the Airship SDK

      
        

   • Make sure to follow the steps in Airship's documentation here.

      
    
 

5. Admin access to your Airship account.

Enable Airship

Complete the following steps to enable Airship:

1. Retrieve IDs from Airship

Before you can enable the integration in Branch, 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

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

2. Connect Airship in Branch

In Branch, go to Configuration > Integrations and select the Data tab. Search for Airship and select it to open its data partner page.

In the Export section, enter the following, then toggle Export to Enabled and select Save:

 

• Domain associated with your Airship project (required) — go.urbanairship.com for the North American cloud site or go.airship.eu for the European cloud site.

 

• Application Key (required)

 

• Access token (required)

3. Pass metadata to the Branch SDK

 

   

Developer Required

 

 

Developers on your mobile app are required for this step.

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

 

• setRequestMetadataKey() method of the Branch SDKs

 

   

IMPORTANT

 

 

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

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 Airship. To verify data is being sent from Branch to Airship, you can look at Branch's Liveview Webhook Records and apply the following filter:

 

   

Wait Period

 

 

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