Airship Connector Setup Guide
This article describes how to set up the Airship connector.
|Create Custom Event||✓||✓|
Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article.
After adding the connector, configure the following settings:
Required: Select the region associated with your Airship project.
- Access Token
Required: Access Token is used to make API calls.
- App Key
App Key is used to make API calls for the action “Create Custom Event”.
Action settings - parameters and options
Click Next or go to the Actions tab. This is where you configure connector actions.
This section describes how to set up parameters and options for each action.
Action - Create Custom Event
This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met:
- Max number of requests: 100
- Max time since oldest request: 5 minutes
- Max size of requests: 1 MB
|Named User Id||(Required) The named user associated with the event.|
|Event Name||(Required) The name for the event.|
|Interaction Id||The identifier defining where the event occurred. In a traditional website, which would be the path and query string from the URL. In a single page app that uses hash routing, it would be the path, query string, and fragment identifier.|
|Interaction Type||Describes the type of interaction that triggered the event. For example: ‘url’, ‘social’, ‘email’. This should almost always be ‘url’ for web events. Airship can separate events with the same name by interaction_type, providing greater insight into custom events.|
|Occurred||The timestamp the event happened for the user in ISO 8601 UTC format ‘YYYY-MM-DDThh:mm:ss’. If no Timestamp is provided, the current timestamp will be used.|
|Session Id||The user session during which the event occurred.|
|Transaction||If the event is one in a series representing a single transaction, use the transaction field to tie events together.|
|Value||The Value field respects six digits of precision to the right of the decimal point.|
|Properties||Map properties as key-value pairs for top-level attributes.
Map and use a template for more complex data structures.
|Template Variables||Optional: provide template variables for Properties object data. For more information, see: Template Variables Guide.
Name nested template variables with the dot notation (Example: items.name).
Nested template variables are typically built from data layer list attributes.
|Templates||Optional: provide template for properties object. (see: Templates Guide)
Map template name, wrapped in double curly braces, to Properties in Event Data mapping above. For example,
Action - Add Tags
|Named User Id||The named user to associate tags with.|
|Tags||The list of tags to add to the named user. If the tags are already present, they are not modified.
Map an array of tag values when adding multiple tags to the same tag group.
Action - Remove Tags
|Named User Id||The named user to disassociate tags with.|
|Tags||The list of tags to remove from the named user. If the tags are not currently present, nothing happens.
Map an array of tag values when removing multiple tags from the same tag group.
Action - Set Attributes
|Named User Id||The named user to set attributes on.|
|Title, First Name, Last Name, Full Name, Gender, Zipcode, City, Region, Country, Birthdate, Age, Mobile Phone, Home Phone, Work Phone, Loyalty Tier, Company, Username, Account Creation, Email Address, Altitude, Latitude, Longitude, Advertising ID (IDFA)||Map to Airship predefined or custom attributes. Custom attributes must be added in the Airship UI before they can be mapped.|
Action - Remove Attributes
|Named User Id||The named user to remove attributes from.|
|Attributes||The list of attributes to remove from the named user.|
Thank you for your feedback!
This page was last updated: January 20, 2022