Skip to content

Commit e37d71f

Browse files
author
Borys Bielinskyi
committed
Update information about the Airship destination and source
1 parent 72365fc commit e37d71f

File tree

2 files changed

+61
-29
lines changed
  • src/connections

2 files changed

+61
-29
lines changed

src/connections/destinations/catalog/airship/index.md

Lines changed: 54 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@ rewrite: true
33
title: Airship Destination
44
---
55

6-
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.
6+
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 at the right moment — building trust, boosting engagement, driving action, and growing value.
7+
8+
[Airship Cloud-mode Destination integration](https://docs.airship.com/partners/segment/#destination) enables users to set Airship Tags and Custom Events through Segment's `identify`, `track`, and `group` API calls.
9+
10+
Segment `track` API calls are received by Airship as Custom Events. The traits of the Segments `identify` API call are interpreted as either `tags` or `attributes`. Tags are all traits that contains a boolean value (either `true` or `false`). A trait which contains a non-boolean value -- and is known to Airship -- becomes an attribute.
11+
12+
Segment `group` API calls associate a named user with a group. Similar to `identify` API calls, `group` calls contain a set of `traits` that Airship uses as `tags` and `attributes`.
713

8-
[Airship Cloud-mode Destination integration](https://docs.airship.com/partners/segment/#destination) enables users to set Airship Tags and Custom Events through Segment Identify and Track events.
914

1015
This destination is maintained by Airship. For any issues [contact the Airship Support team](mailto:[email protected]).
1116

@@ -20,22 +25,23 @@ This destination is maintained by Airship. For any issues [contact the Airship S
2025

2126
Follow these steps to configure the integration
2227

23-
1. From the Segment web app, click **Catalog**.
24-
2. Search for "Airship" in the Catalog, select it, and choose which of your sources to connect the destination to.
25-
3. Enter the "API Key" into your Segment Settings UI.
26-
* Steps to create an Access Token to enable integration from Airship outlined [here](https://docs.airship.com/partners/segment/#access-token). Save this Access Token & API Key for the pasting into Segment Settings UI.
27-
4. For Identify Events, be sure to set up a Tag Group first within Airship. Steps outlined [here](https://docs.airship.com/partners/segment/#tag-group).
28+
1. Log in to your Segment workspace
29+
2. Go to the **Catalog** and click the **Destinations** tab.
30+
3. Find the `Airship` destination (under *SMS & Push Notifications*), click the *Airship* tile and then click the *Configure Airship* button.
31+
4. In the *Select Source* dialog, select a source and click *Confirm Source*.
32+
5. Toggle on *Airship EU Data Center* if you are implemented in Airship's European Data Center (if you are not sure which data center you are on please [contact the Airship support team](mailto:[email protected])).
33+
3. Enter the *App Key* and Access Token that you copied when setting up the Real-Data Streaming integration in Airship. See [Airship documentation for steps to create an Access Token](https://docs.airship.com/partners/segment/#access-token).
34+
4. For `identify` events, first [set up a tag group within Airship](https://docs.airship.com/partners/segment/#tag-group).
35+
5. For `attributes`, first [predefine them in Airship](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/#add-attributes).
2836

2937
## Requirements
30-
To use the Segment Destination integration, you must implement Named Users in Airship. The Segment UserID must match the Named User ID in Airship.
31-
32-
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
38+
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. You will not be able to issue automated messages or to attach user attributes from Segment within Airship.
3339

3440
See [Tags and Named Users](https://docs.airship.com/guides/audience/tags-named-users/) or the [Named Users API](https://docs.airship.com/api/ua/#tag/named-users) for more information about configuring named users.
3541

3642
## Identify
3743

38-
If you haven't had a chance to review the Segment spec, take a look tounderstand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like:
44+
To understand what the [identify API call](https://segment.com/docs/connections/spec/identify/) does, be sure to review the Segment spec. An example call would look like:
3945

4046
```
4147
analytics.identify('jill', {
@@ -44,20 +50,24 @@ analytics.identify('jill', {
4450
});
4551
```
4652

47-
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 set up 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.
53+
The `identify` API calls are sent to Airship as `identify` events. When an `identify` event is received, Airship will use the `userId` to set attributes or tags for named users. To take advantage of attributes, you must first predefine them in Airship individually. To take advantage of identify features, in Airship you must set up a tag group called `segment-integration` and a named user must exist for the `userId`. The value of the property name will be either `true` or `false`.
54+
55+
**Segment Identify Events to Airship Attributes**
56+
57+
Airship attributes are used for profile enrichment, message personalization, segment building, and user analytics.
4858

4959
**Segment Identify Events to Airship Tags**
50-
Airship Tags are used for profile enrichment, message triggering, segment building, and user analytics.
60+
Airship tags are used for profile enrichment, message triggering, segment building, and user analytics.
5161

52-
Example Use cases:
53-
* Identify event sets an Airship tag on a user is flagged as liking a specific product category
54-
* Identify event sets an Airship tag on a user registers for an account
62+
Example use cases in Airship:
63+
* An `identify` event sets a tag to mark the user as *liking a specific product category*
64+
* An `identify` event sets an attribute on a user who *registers for an account*
5565

5666
## Track
5767

58-
Use this Destination to send `Track` events to Airship for message triggering and analytics.
68+
Use this destination to send `track` events to Airship for message triggering and analytics.
5969

60-
If you haven't had a chance to review the Segment spec, take a look to understand what the [Track method](https://segment.com/docs/connections/spec/track/) does. An example call would look like:
70+
For more information about the [track API call](https://segment.com/docs/connections/spec/track/) review the Segment spec. An example call would look like:
6171

6272
```
6373
analytics.track('Product Clicked', {
@@ -69,25 +79,43 @@ analytics.track('Product Clicked', {
6979
});
7080
```
7181

72-
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.
82+
The `track` API calls are sent to Airship as `track` events. As soon as a `track` event is received, Airship will create a custom event. The properties of the the `track` event are automatically added as properties on the custom event. If `revenue` is present for the `track` event, then it is set as the value of the custom event.
7383

74-
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.
84+
Note that a custom event will not be created for a `track` event which has more than 20 properties.
7585

7686
**Segment Track Events to Airship Custom Events**
77-
Airship Custom Events are used to trigger automated messages for Mobile App, Web Notifications, Email, and SMS messages.
87+
Airship custom events are used to trigger automated messages for Mobile App, Web Notifications, Email, and SMS messages.
88+
89+
Example use cases:
90+
* The `track` event triggers an Airship custom event on a user who has `abandoned a cart` and an Airship message is triggered for reengagement
91+
* The `track` event triggers an Airship custom event on a user who has `uninstalled the app` to trigger an SMS, Email, or Web Notification
7892

79-
Example Use cases:
80-
* Track event triggers an Airship Custom Event on a user who has abandoned cart and an Airship message is triggered for reengagement
81-
* Track event triggers an Airship Custom Event on a user who uninstalled the app to trigger an SMS, Email, or Web Notification
93+
Custom events and tags sent from Segment are automatically populated within Airship Performance Analytics reporting dashboards.
94+
95+
## Group
96+
97+
For more information about the [group API call](https://segment.com/docs/connections/spec/group/) review the Segment spec. An example call would look like:
98+
99+
```
100+
analytics.group('1234', {
101+
name: 'Initech',
102+
industry: 'Technology',
103+
employees: 329,
104+
plan: 'enterprise',
105+
totalBilled: 830
106+
});
107+
```
82108

83-
Custom Events and Tags sent from Segment are automatically populated within Airship Performance Analytics reporting dashboards.
109+
When you call `group`, Segment sends a custom attribute to Airship with the name `airship_segment_group_<groupId>`, where `<groupId>` is the group's ID passed as one of its parameters. For example, if the group's ID is `1234` then the custom attribute name is `airship_segment_group_1234`. The value of the custom attribute is `true`.
84110

111+
To take advantage of `group` features as tags, set up a tag group called `segment-integration-group` in Airship. A *named user* must exist for the `userID`.
85112

86113
# Leveraging this data in Airship
87114

88-
Follow the below guides for further explaination and the different ways of leveraging this data with Airship.
115+
The following guides further explain the different ways of leveraging this data with Airship.
89116

90117
* [Cloud-mode Custom Events vs Audience Tags](https://docs.airship.com/guides/interaction/custom-events/#custom-events-vs-audience-tags)
91118
* [Message Targeting with Tags](https://docs.airship.com/guides/audience/tags-named-users/)
92119
* [Creating a Segment with Tags](https://docs.airship.com/tutorials/audience/segments-builder/)
93120
* [Message Automation with Event Triggering](https://docs.airship.com/tutorials/orchestration/automation/automation/)
121+
* [Message Personalization with Attributes](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/)

src/connections/sources/catalog/cloud-apps/airship/index.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
title: Airship Source
33
---
44

5-
[Airship](https://www.airship.com) 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.
5+
[Airship](https://www.airship.com) 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 at the right moment — building trust, boosting engagement, driving action and growing value.
66

7-
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.
7+
Real-Time Data Streaming 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.
88

9-
This Source integration is maintained by Airship. For any issues with the source, [contact the Airship Support team](mailto:partner-integration-ua@airship.com).
9+
This Source integration is maintained by Airship. For any issues with the source, [contact the Airship Support team](mailto:support@airship.com).
1010

1111
> success ""
1212
> **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](/docs/connections/destinations/catalog/airship/), which receives data from Segment!
@@ -28,6 +28,10 @@ This Source integration is maintained by Airship. For any issues with the source
2828
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.
2929

3030
<table>
31+
<tr>
32+
<td>Attribute Operation</td>
33+
<td>Indicates a change in the device's attributes. Because attribute operations are related to a device they have a *device* field.</td>
34+
</tr>
3135
<tr>
3236
<td>Open</td>
3337
<td>Occurs when a user opens your app.</td>

0 commit comments

Comments
 (0)