Airship Source

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.

Real-Time Data Stream automatically collects user-level data and sends the data to Segment for analysis or action through other Destination integrations. At Airship, we understand that seamlessly tying data across platforms can be a complex task. This integration removes the development so users can get back to understanding their audience and reaching them on their preferred channel.

This Source integration is maintained by Airship. For any issues with the source, please reach out to their team.

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

Getting Started

  1. From your Segment UI’s Sources page click on “Add Source”.
  2. Search for Airship within the Sources Catalog and confirm by clicking “Connect”.
  3. Give the Source a nickname and follow the setup flow to “Add Source”. The nickname will be used to designate the source in the Segment interface, and Segment will create a related schema name. The schema name is the namespace you’ll be querying against in your warehouse. The nickname can be whatever you like, but we recommend sticking to something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).
  4. Copy the Write key from the Segment UI and log in to your Airship account - navigate to Settings > Real-Time Data Stream > Segment and follow the steps for configuration.

Events

Below is a table of events that Airship sends to Segment. These events will show up as tables in your warehouse, and as regular events in your other Destinations. Airship will send through the userId if available.

OpenOccurs when a user opens your app.
CloseOccurs when a user closes the app. Close events are often latent, as they aren’t sent back to Airship until the user activates the app again.
Custom EventRepresents custom events that are either emmitted from the Airship SDK or submitted through the Custom Events API.
Screen ViewedOccurs when a user has finished viewing a screen within the app.
SendOccurs whenever a push notification is sent to a device identified in the audience selector of a message.
ControlOccurs when a device is excluded from a push because it was arbitrarily selected as a member of a control group.
Tag ChangeOccurs when tags are added or removed for a user.
First OpenThis event occurs when a user opens an Airship-integrated app for the first time.
First Opt-inThis event appears in the stream when a channel is first opted in. This event is specific to email (commercial), sms and open channels.
UninstallOccurs when a user uninstalls an Airship-integrated app in response to a push.
In-App Message Expiration, Resolution, Display EventsOccurs when an in-app message expires, resolved, and displayed to a user.
Message Center Read, Delivery, Delete EventsOccurs when a Message Center message is read, deleted, or delivered to a users inbox.

Event Properties

Below are tables outlining the properties included in the events listed above.

Property NameDescription
airship_offsetAn identifier of a location in the stream; used to resume the stream after severing a connection.
anonymousIdThe channel identifier.
background_push_enabledIndicates whether or not the device has background push notifications enabled.
body_session_idRepresents the “session” of user activity. Absent if the application was initialized while backgrounded.
body_sourceThe event source. Possible values: SDK, API. The event source. SDK indicates an event sent from the UA SDK. API indicates an event created by request against the Server Side Custom Events API.
location_permissionPossible values: SYSTEM_LOCATION_DISABLED, NOT_ALLOWED, ALWAYS_ALLOWED, FOREGROUND_ALLOWED, UNPROMPTED
messageIdUniquely identifies the Airship event.
push_opt_inIndicates whether or not the device is opted into push notifications.
ua_sdk_versionThe version of the Airship SDK used in the app.
userIdThe named user identifier for the device.

Adding Destinations

Now that your Source is set up, you can connect it with Destinations.

Log into your downstream tools and check to see that your events are populating and they contains all the properties you expect. If all your events and properties are not showing up, refer to the Destination docs for troubleshooting.

For any issues with the Source events, please reach out to the Airship team.



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