Skip to main content
Airship - Dynamic Optimisation - Getting Started

Set up the two critical integration components in Airship

Updated over 2 months ago

Setting up Jacquard's Dynamic Optimisation integration for Airship mobile push messages requires two major components: an Airship External Data Feed and an Airship Real-Time Data Stream.

You'll need someone with Administrator or Owner access to your Airship account to set up the integration.

To summarize the integration mechanics, External Feeds call variants in from Jacquard and Real-Time Data Streams pass engagement data to Jacquard.

Both are critical for Dynamic Optimisation to function properly. Read on to learn more about the components.

Components defined

Airship External Data Feed

The External Data Feed feature in Airship is a feature the Jacquard integration leverages to serve content variants to your subscribers in real time at the point of deployment.

The data feed will essentially call out to Jacquard via a particular URL and pass along several properties so Jacquard knows it's safe to respond with content.

You can learn more about External Data Feeds in Airship's documentation.

Configuring an External Data Feed is straightforward and requires filling out a creation wizard in Airship.

Airship Real-Time Data Stream

The Real-Time Data Stream service in Airship allows you to pass along the engagement data associated with your mobile push messages to Jacquard. This is done via a partner service. Jacquard uses AWS Kinesis Data Streams, so that's the partner integration we'll select during setup.

Real-Time Data Streaming is a paid add-on to your Airship account. If you don't have any connectors available, speak with your Airship account manager to discuss pricing and access.

To learn more about Real-Time Data Streams, visit Airship's knowledge base.

Airship External Data Feed setup

This data feed is reusable and only needs to be set up once per Airship project.

1. Navigate to External Data Feeds

You'll find External Data Feeds within the Settings section of Airship.

Once there, click Manage within the External Data Feeds box. You'll find it near the bottom of the page.

2. Create a new data feed

Click Add data feed at the top of the page.

3. Configure the data feed

Fill out the data feed creation wizard fields using the following values:

Ensure you leave Cache response unchecked. Your fields should now match the image below:

4. Add your Jacquard API authorization token

In the wizard, click Add header.

Enter the word Authorization in the Key field.

Next, you'll need to retrieve your API token from the Jacquard user interface.

If there isn't already an authorization token created in your account, you'll need to create one. Directions for creating and retrieving your token are available in the Jacquard Help Centre.

Both creating and retrieving tokens in Jacquard requires Admin access. Never store your Jacquard token outside of a secure platform. Never share your token via email or instant message, as this will compromise your token and necessitate deletion and recreation.

With your token in hand, enter the word Bearer followed by a space in the Value field. Then, paste your Jacquard API token.

Your completed wizard should now match the following image:

Click Next.

5. Confirm and save your data feed

Check the box next to Yes, I confirm my organization has the proper rights to make requests to realtime.phrasee.co. Then, click Next.

Finally, click Save.

Airship Real-Time Data Stream setup

This data stream is reusable and only needs to be set up once per Airship project.

When you're ready to set up your Real-Time Data Stream, reach out to your Jacquard Customer Success representative for the appropriate credentials to use for the connection.

1. Navigate to Real-Time Data Streaming

You'll find Real-Time Data Streaming within the Settings section of Airship.

Once there, click Manage within the Real-Time Data Streaming box. You'll find it just beneath the Project configuration heading.

2. Create a new Airship to Amazon Kinesis data stream

Click on the Amazon Kinesis box beneath the Real-Time Data Streaming heading.

3. Configure the data stream

Name your data stream Jacquard Data Stream and add Sends Airship engagement data to Jacquard's Amazon Kinesis stream as the description.

Continue down the page and add in the credentials Jacquard provided to you for the Access Key, Access Secret, and Kinesis Stream Name.

Choose eu-west-1 for the AWS Region.

Tick the boxes next to the following event types:

  • Opens

  • Push Bodies

  • Send Aborted

  • Send Rejected

  • Sends

4. Confirm and activate your data stream

After reviewing your selections and credentials carefully, click Activate at the bottom of the screen.

Article path

Next Article

Related articles

Page last reviewed: 23 September 2024

Did this answer your question?