Airship Source


Good to know: Event source

The Airship Source is an event source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and also sent to Segment streaming destinations. Learn more about cloud sources.

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, contact the Airship Support team.

Good to know: This page is about the Airship Segment source, which sends data into Segment. There’s also a page about the Airship Segment destination, which receives data from Segment!

This document is about a source which is in beta

This means that the Airship Source is in active development, and some functionality may change before it becomes generally available.

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 set up 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.

Open Occurs when a user opens your app.
Close Occurs 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 Event Represents custom events that are either emmitted from the Airship SDK or submitted through the Custom Events API.
Screen Viewed Occurs when a user has finished viewing a screen within the app.
Send Occurs whenever a push notification is sent to a device identified in the audience selector of a message.
Control Occurs when a device is excluded from a push because it was arbitrarily selected as a member of a control group.
Tag Change Occurs when tags are added or removed for a user.
First Open This event occurs when a user opens an Airship-integrated app for the first time.
First Opt-in This event appears in the stream when a channel is first opted in. This event is specific to email (commercial), sms and open channels.
Uninstall Occurs when a user uninstalls an Airship-integrated app in response to a push.
In-App Message Expiration, Resolution, Display Events Occurs when an in-app message expires, resolved, and displayed to a user.
Message Center Read, Delivery, Delete Events Occurs 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 Name Description
airship_offset An identifier of a location in the stream; used to resume the stream after severing a connection.
anonymousId The channel identifier.
background_push_enabled Indicates whether or not the device has background push notifications enabled.
body_session_id Represents the “session” of user activity. Absent if the application was initialized while backgrounded.
body_source The 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_permission Possible values: SYSTEM_LOCATION_DISABLED, NOT_ALLOWED, ALWAYS_ALLOWED, FOREGROUND_ALLOWED, UNPROMPTED
messageId Uniquely identifies the Airship event.
push_opt_in Indicates whether or not the device is opted into push notifications.
ua_sdk_version The version of the Airship SDK used in the app.
userId The 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, contact the Airship team.

This page was last modified: 15 Oct 2020

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account