Table of Contents
Note: The Airship integration is only available on the Growth/Enterprise plan.
Overview
This integration combines Amplitude's analytics with Airship's customer engagement tools into one unified system. Using this integration will allow you to interact with any user segment or cohort via push notifications, in-app messages, and more to advance your app engagement or conversion goals. Please continue reading to learn more about how to set up this integration.
Additionally, Amplitude and Airship offer a new form of partnership that sends events from Airship to Amplitude if you have an Airship plan that includes Real-Time Data Streaming! For more information, visit docs.airship.com/partners/amplitude/
How It Works
To leverage Amplitude behavioral cohorts within Airship:
1. If you are using Amplitude's SDKs, you will need to integrate both the Airship and Amplitude SDKs in your app and follow instructions below to link their key identifiers. If you are using our HTTP API to send server-side events, you can send these key identifiers as user properties via Identify API.
- Amplitude:
- Airship:
2. In the app code, you will need to link identifiers between two services. IMPORTANT NOTE: The recommended solution is to store your Airship Channel ID as a custom User Property in Amplitude, named UAChannelID.
Use this code snippet for iOS:
AMPIdentify *identify = [[AMPIdentify identify] set:@"UAChannelID" value:[UAirship push].channelID]; [[Amplitude instance] identify:identify];
Use this code snippet for Android:
Identify identify = new Identify().set("UAChannelID", UAirship.shared().getPushManager().getChannelId()); Amplitude.getInstance().identify(identify);
Example call for Identify API:
curl --data 'api_key=040062a5d38552315b98302ba4f2f' --data 'identification=[{"user_id":"datamonster@gmail.com", "user_properties":{"UAChannelID":"12345-6789-01234"}}]' https://api.amplitude.com/identify
When configured properly, you can look up your test user or device in Amplitude and see the UAChannelID property stored the User Properties, as seen below.
3. Next, you will configure the integration in the Amplitude Dashboard. To do so, go navigate to Manage Data > Select the Project > Advanced > Integrations. Click on Airship and a pop-up will appear:
- First, enter your Airship Secret Key (currently labeled as App Master Secret in Airship) and Airship API Key (currently labeled as App Key in Airship).
- Next, configure the mapping correctly in the Amplitude Dashboard. We recommend following our standard recommendations and mapping “UAChannelID” to Auto Channel ID in Airship for the ease of integration. However, you can map User ID, Device ID, or any user property on Amplitude to any Airship ID.
Note: Auto Channel maps to the channel ID of the correct platform (Android or iOS) in Airship automatically.
4. The last configuration you have to do is to create a tag group called Amplitude in Airship.
- In Airship, go to Settings -> "APIs and Integrations" and click on "Tag Groups". Fill in the Tag Group with the following information like in the image. Most importantly, make sure that the group key is "amplitude".
5. When your app update is deployed, you are ready to go.
- Create a Behavioral Cohort in Amplitude: In our example below, we are creating one that counts when a device performs 'PurchaseSubscription' at least once in the last 30 days.
- Ensure that your cohort has at least 1 device/user listed.
- In the Behavioral Cohorts, click on the "Sync to..." icon and select "Airship."
- Your Airship Dashboard will begin processing this cohort as a new Tag under the "Amplitude" tag group.
5. Once the tag has successfully been processed, compose your message in Airship’s Message Composer, and you’ll find your Amplitude-defined tags in the search bar under the Amplitude tag group.
6. Send messages and watch your engagement results in Amplitude and Airship.