Airship Destination

Airship gives brands the data, channels, orchestration and services they need to deliver push notifications, emails, SMS, in-app messages, and more to the right person in the right moment — building trust, boosting engagement, driving action and growing value.

Airship Cloud-mode Destination integration enables users to set Airship Tags and Custom Events through Segment Identify and Track events.

This destination is maintained by Airship. For any issues please reach out to their team.

NOTE: The Airship Destination is currently in beta, which means that they are still actively developing the destination. This doc was last updated on July 31, 2019. If you are interested in joining their beta program or have any feedback to help improve the Airship Destination and its documentation, please let their team know!

Getting Started

The first step is to make sure Airship supports the source type and connection mode you’ve chosen to implement. You can learn more about what dictates the connection modes we support here.

WebMobileServer
📱 Device-mode
☁️ Cloud-mode

Follow these steps to configure the integration

  1. From your Segment UI’s Destinations page click on “Add Destination”.
  2. Search for “Airship” within the Destinations Catalog and confirm the Source you’d like to connect to.
  3. Drop in the “API Key” into your Segment Settings UI.
  • Steps to create an Access Token to enable integration from Airship outlined here. Save this Access Token & API Key for the pasting into Segment Settings UI.
  1. For Identify Events, be sure to set up a Tag Group first within Airship. Steps outlined here.

Requirements

To use the Segment Destination integration, you must implement Named Users in Airship. The Segment UserID must match the Named User ID in Airship.

If your named_user_id and UserID do not match, Airship will not be able to associate Identify or Track events to the proper user in Airship. This would prevent you from effectively issuing automated messages or attaching user attributes from Segment within Airship

See Tags and Named Users or the Named Users API for more information about configuring named users.

Identify

If you haven’t had a chance to review the Segment spec, please take a look to understand what the Identify method does. An example call would look like:

analytics.identify('jill', {
  new_customer: true,
  order_completed_last_60days: false,
});

Identify calls will be sent to Airship as an identify event. When an identify event is received, Airship will use the userId to set named users tags. To take advantage of identify features, in Airship you must setup a tag group called segment-integration and a named user must exist for the userId. The value of the property name will be true/false value.

Segment Identify Events to Airship Tags Airship Tags are leveraged for profile enrichment, message triggering, segment building, and user analytics.

Example Use cases:

  • Identify event sets an Airship tag on a user is flagged as liking a specific product category
  • Identify event sets an Airship tag on a user registers for an account

Track

Use this Destination to send Track events to Airship for message triggering and analytics.

If you haven’t had a chance to review the Segment spec, take a look to understand what the Track method does. An example call would look like:

analytics.track('Product Clicked', {
  name: 'Air Jordans',
  brand: 'Nike ',
  price: 200,
  quantity: 1,
  variant: 'Red'
});

Track calls will be sent to Airship as a track event. When a track event is received, an Airship custom event will be created. The event’s properties will be automatically added as properties on the custom event and if revenue is present that will be set at the custom event’s value.

There is a maximum limit of 20 properties for track events. A custom event will not be created for a track event whose properties count exceeds the limit.

Segment Track Events to Airship Custom Events Airship Custom Events are used to trigger automated messages for Mobile App, Web Notifications, Email, and SMS messages.

Example Use cases:

  • Track event triggers an Airship Custom Event on a user who has abandoned cart and an Airship message is triggered for reengagement
  • Track event triggers an Airship Custom Event on a user who uninstalled the app to trigger an SMS, Email, or Web Notification

Custom Events and Tags sent from Segment are automatically populated within Airship Performance Analytics reporting dashboards.

Leveraging this data in Airship

Follow the below guides for further explaination and the different ways of leveraging this data with Airship.


Personas

You can send computed traits and audiences generated through Segment Personas to this destination as a user property. To learn more about Personas, reach out for a demo.

For user-property destinations, an identify call will be sent to the destination for each user being added and removed. The property name will be the snake_cased version of the audience name you provide with a true/false value. For example, when a user first completes an order in the last 30 days, we will send an identify call with the property order_completed_last_30days: true, and when this user no longer satisfies we will set that value to false.

When the audience is first created an identify call is sent for every user in the audience. Subsequent syncs will only send updates for those users which were added or removed since the last sync.

Settings

Segment lets you change these destination settings via your Segment dashboard without having to touch any code.

API Key

Airship generated string identifying the Bearer token.

App Key

Airship generated string identifying the app setup. Used in the application bundle.

Adding Airship to the integrations object

To add Airship to the integrations JSON object (for example, to filter data from a specific source), use one of the 2 valid names for this integration:
  • airship
  • Airship


  • Questions? Need help? Contact us!
    Can we improve this doc?
    Email us: docs-feedback@segment.com!