Search documentation...

K
ChangelogBook a demoSign up

Airship

Build better campaigns on Airship with up-to-date customer data from your data warehouse

View Airship's documentation.

Supported syncing

TypeDescriptionSupported Sync ModesAPI Reference
Named usersSync tags and attributes to named users in AirshipUpsert, UpdateNamed users docs
Subscription listsSubscribe and unsubscribe named users from subscription listsAdd, RemoveSubscription lists docs

For more information about sync modes, refer to the sync modes docs.

Connect to Airship

Go to the Destinations overview page and click the Add destination button. Select Airship and click Continue. You can then authenticate Hightouch to Airship using either basic authentication or bearer authentication.

For both types, you need to enter your Airship Cloud Site. See Airship's docs for more info.

Then, for basic authentication, enter these fields:

  • App Key: This is an Airship-generated string identifying your application. You can find it in your Airship dashboard.
  • Master Secret: Airship-generated string used for server-to-server API access. You can find it in your Airship dashboard.

Follow the instructions in this article to retrieve your App Key and Master Secret

For bearer authentication:

  • Access Token: This is an access token used to grant control permissions to the Airship API.

Follow the instructions in this article to retrieve your Access token.

Sync configuration

Once you've set up your Airship destination and have a model to pull data from, you can set up your sync configuration to begin syncing data. Go to the Syncs overview page and click the Add sync button to begin. Then, select the relevant model and the Airship destination you want to sync to.

Syncing named users

Sync tags and attributes to named users in Airship. Begin by selecting Object as your sync type.

Record matching

To match rows from your model to named users in Airship, you need to select the model column that contains values that match the Named User ID field.

Field mapping

You can sync columns from your model to Airship attributes and tags.

Hightouch provides a dropdown for default attributes and predefined attributes. If you want to map custom attributes, you have to manually enter the attribute ID, not attribute name in the mapper.

Although predefined attributes are avaliable in the dropdown by default, you must first define them in Airship for them to be valid. Airship skips invalid attributes by default.

Hightouch allows you to sync values to existing tag groups in Airship. Enter the Group key in the right side of the tags mappings section to map values to an existing tag group. See Airship's docs for more information on tag groups.

You can map string or array values to tags. If you provide a string, Hightouch automatically transforms it into an array using commas as the delimiters for different elements. For example, Hightouch transforms the string "dogs, cats, parrots" into this array: ["dogs, "cats", "parrots"].

Syncing subscription lists

Syncs can subscribe and unsubscribe named users from subscription lists.

Record matching

To match rows from your model to named users in Airship, you need to select the model column that contains values that match the Named User ID field.

Field mapping

You can map data from any of your model columns to fields in Airship. Airship requires the Scopes field, so you must map it to complete your configuration. Refer to Airship's scopes docs to see valid values.

Ensure the data types of your model columns match the data types of the fields you want to sync to.

Tip and troubleshooting

Common errors

To date, our customers haven't experienced any errors while using this destination. If you run into any issues, please don't hesitate to . We're here to help.

Live debugger

Hightouch provides complete visibility into the API calls made during each of your sync runs. We recommend reading our article on debugging tips and tricks to learn more.

Sync alerts

Hightouch can alert you of sync issues via Slack, PagerDuty, SMS, or email. For details, please visit our article on alerting.

Ready to get started?

Jump right in or a book a demo. Your first destination is always free.

Book a demoSign upBook a demo

Need help?

Our team is relentlessly focused on your success. Don't hesitate to reach out!

Feature requests?

We'd love to hear your suggestions for integrations and other features.

Last updated: May 3, 2023

On this page

Supported syncingConnect to AirshipSync configurationSyncing named usersSyncing subscription listsTip and troubleshootingCommon errorsLive debuggerSync alerts

Was this page helpful?