You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: src/connections/destinations/catalog/airship/index.md
+149-33
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,14 @@ rewrite: true
3
3
title: Airship Destination
4
4
---
5
5
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, attributes, 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`.
7
13
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.
9
14
10
15
This destination is maintained by Airship. For any issues [contact the Airship Support team](mailto:[email protected]).
11
16
@@ -20,22 +25,23 @@ This destination is maintained by Airship. For any issues [contact the Airship S
20
25
21
26
Follow these steps to configure the integration
22
27
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).
28
36
29
37
## 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`, `track`, or `group` 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.
33
39
34
40
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.
35
41
36
42
## Identify
37
43
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 the Identify API call, review the Segment [Identify](/docs/connections/spec/identify/)spec. An example call looks like:
39
45
40
46
```
41
47
analytics.identify('jill', {
@@ -44,20 +50,25 @@ analytics.identify('jill', {
44
50
});
45
51
```
46
52
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
48
56
49
-
**Segment Identify Events to Airship Tags**
50
-
Airship Tags are used for profile enrichment, message triggering, segment building, and user analytics.
57
+
Airship attributes are used for profile enrichment, message personalization, segment building, and user analytics.
51
58
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
59
+
## Segment Identify Events to Airship Tags
60
+
61
+
Airship tags are used for profile enrichment, message triggering, segment building, and user analytics.
62
+
63
+
Example use cases in Airship:
64
+
* An `identify` event sets a tag to mark the user as *liking a specific product category*
65
+
* An `identify` event sets an attribute on a user who *registers for an account*
55
66
56
67
## Track
57
68
58
-
Use this Destination to send `Track` events to Airship for message triggering and analytics.
69
+
Use this destination to send `track` events to Airship for message triggering and analytics.
59
70
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:
71
+
For more information about the Track API call review the Segment [Track]((/docs/connections/spec/track/)) spec. An example call looks like:
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.
83
+
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.
84
+
85
+
### Segment Track Events to Airship Custom Events
86
+
87
+
Airship custom events are used to trigger automated messages for Mobile App, Web Notifications, Email, and SMS messages.
73
88
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.
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
75
92
76
-
**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.
93
+
Custom events and tags sent from Segment are automatically populated within Airship Performance Analytics reporting dashboards.
78
94
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
95
+
## Group
82
96
83
-
Custom Events and Tags sent from Segment are automatically populated within Airship Performance Analytics reporting dashboards.
97
+
For more information about the Group API call review the Segment [Group](/docs/connections/spec/group/) spec.
98
+
99
+
When you call `group`, the integration sets either Airship tags or attributes for
100
+
corresponding Segment traits. A *named user* must exist in Airship for the corresponding
101
+
value of `userID` in Segment.
102
+
103
+
### UserID in Segment group API call
104
+
105
+
```
106
+
{
107
+
...
108
+
"userId": "test-user-69w86c"
109
+
...
110
+
}
111
+
```
112
+
113
+
### Named user in the corresponding Airship payload
114
+
```
115
+
{
116
+
"audience": {
117
+
"named_user_id": "test_user-69w86c"
118
+
},
119
+
...
120
+
}
121
+
```
84
122
123
+
Airship tags are set for those Segment traits that contain a boolean value (either `true`
124
+
or `false`). All tags from `group` API calls are added to the `segment-integration-group` tag
For Segment traits that contain values of other types, such as numeric or text, Airship sets custom attributes. The integration maps the Segment group trait `name` to the Airship predefined attribute `company`. All other traits are prefixed with `airship_segment_group_`. Names of nested traits also include their parent traits delimited by underscore (_).
153
+
154
+
### A Segment group call with non-boolean traits
155
+
156
+
```
157
+
...
158
+
"traits": {
159
+
"name": "Initech",
160
+
"industry": "Technology",
161
+
"employees": 329,
162
+
"address": {
163
+
"city": "Portland",
164
+
...
165
+
}
166
+
}
167
+
...
168
+
```
169
+
170
+
### Setting the corresponding Airship attributes
171
+
```
172
+
...
173
+
"attributes": [
174
+
{
175
+
"action": "set",
176
+
"key": "company",
177
+
"value": "Initech",
178
+
...
179
+
},
180
+
{
181
+
"action": "set",
182
+
"key": "airship_segment_group_industry",
183
+
"value": "Technology",
184
+
...
185
+
},
186
+
{
187
+
"action": "set",
188
+
"key": "airship_segment_group_employees",
189
+
"value": 329,
190
+
...
191
+
},
192
+
{
193
+
"action": "set",
194
+
"key": "airship_segment_group_address_city",
195
+
"value": "Portland",
196
+
...
197
+
}
198
+
...
199
+
```
85
200
86
-
#Leveraging this data in Airship
201
+
## Leverage this data in Airship
87
202
88
-
Follow the below guides for further explaination and the different ways of leveraging this data with Airship.
203
+
The following guides further explain the different ways of leveraging this data with Airship.
89
204
90
-
*[Cloud-mode Custom Events vs Audience Tags](https://docs.airship.com/guides/interaction/custom-events/#custom-events-vs-audience-tags)
91
-
*[Message Targeting with Tags](https://docs.airship.com/guides/audience/tags-named-users/)
92
-
*[Creating a Segment with Tags](https://docs.airship.com/tutorials/audience/segments-builder/)
93
-
*[Message Automation with Event Triggering](https://docs.airship.com/tutorials/orchestration/automation/automation/)
205
+
*[Cloud-mode Custom Events vs Audience Tags](https://docs.airship.com/guides/interaction/custom-events/#custom-events-vs-audience-tags){:target="_blank"}
206
+
*[Message Targeting with Tags](https://docs.airship.com/guides/audience/tags-named-users/){:target="_blank"}
207
+
*[Creating a Segment with Tags](https://docs.airship.com/tutorials/audience/segments-builder/){:target="_blank"}
208
+
*[Message Automation with Event Triggering](https://docs.airship.com/tutorials/orchestration/automation/automation/){:target="_blank"}
209
+
*[Message Personalization with Attributes](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/){:target="_blank"}
Copy file name to clipboardexpand all lines: src/connections/sources/catalog/cloud-apps/airship/index.md
+7-3
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
title: Airship Source
3
3
---
4
4
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.
6
6
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.
8
8
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).
10
10
11
11
> success ""
12
12
> **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
28
28
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.
29
29
30
30
<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>
0 commit comments