Setup
-
Click "Add New"
-
Click "Airship"
-
Enter the App Key and Access Token. Follow this documentation to create your Airship Access Token
-
(Optional) If using an Airship EU Data Center, select the correct European Data Center in the dropdown (if you aren't sure which data center you are on please contact the Airship support team.)
-
Add any destination name (for example, "Airship")
-
Click Add Airship
Modes
The Airship destination has two different possible modes.
- Upsert: Upsert mode pushes new objects to Airship and updates fields that change in your warehouse.
- Update: Update mode updates particular fields on existing objects in Airship.
Upsert
In this mode, new objects will be inserted into Airship and all mapped columns will be kept up-to-date within Airship.
This mode is good for the following scenarios:
- You want to create or update users and tags in Airship and want to keep the data up-to-date.
- You want to create Custom Events in Airship.
Upsert has two configuration parameters:
| Name | Description |
|---|---|
| Airship Object Name | The name of the object (Users, Tags, and Custom Events) that will be updated in Airship |
| Hightouch to Airship Field Mappings | A list of columns that will be updated for objects in Airship. Each time a sync occurs in Hightouch these columns will be updated. |
User attributes must be predefined within Airship per the documentation
Update
In this mode, selected columns will be updated for an object within Airship. For example, you could add a new attribute or update a tag an existing user. This mode doesn't create new users or custom events within Airtable. Instead, it updates columns on existing objects.
This mode is good for the following scenarios:
- You have users in Airtable that you want to add additional attributes to
- You want to continuously sync data from your warehouse and add this data to existing objects within Airtable
- You have users in Airtable that you'd like to update their tag
Update has two configuration parameters:
| Name | Description |
|---|---|
| Airship Object Name | The name of the object (Users or Tags) that will be updated in Airship |
| Hightouch to Airship Field Mappings | A list of columns that will be updated for users in Airship. Each time a sync occurs in Hightouch these columns will be updated. |
User attributes must be predefined within Airship per the documentation
Record matching
Users
To update or create user records properly, Airship requires a userId. Once a match is found, we will update a record with the corresponding mapped data. If no record is found, we will create the Named User.
Custom events
A userId must be supplied as a mapped field on a custom event in order for the event to be properly attributed to the correct user.