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
+21-19
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ See [Tags and Named Users](https://docs.airship.com/guides/audience/tags-named-u
41
41
42
42
## Identify
43
43
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:
44
+
To understand the Identify API call, review the Segment [Identify](/docs/connections/spec/identify/) spec. An example call looks like:
45
45
46
46
```
47
47
analytics.identify('jill', {
@@ -52,11 +52,12 @@ analytics.identify('jill', {
52
52
53
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
54
55
-
**Segment Identify Events to Airship Attributes**
55
+
### Segment Identify Events to Airship Attributes
56
56
57
57
Airship attributes are used for profile enrichment, message personalization, segment building, and user analytics.
58
58
59
-
**Segment Identify Events to Airship Tags**
59
+
## Segment Identify Events to Airship Tags
60
+
60
61
Airship tags are used for profile enrichment, message triggering, segment building, and user analytics.
61
62
62
63
Example use cases in Airship:
@@ -67,7 +68,7 @@ Example use cases in Airship:
67
68
68
69
Use this destination to send `track` events to Airship for message triggering and analytics.
69
70
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:
71
+
For more information about the Track API call review the Segment [Track]((/docs/connections/spec/track/))spec. An example call looks like:
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.
83
84
84
-
**Segment Track Events to Airship Custom Events**
85
+
### Segment Track Events to Airship Custom Events
86
+
85
87
Airship custom events are used to trigger automated messages for Mobile App, Web Notifications, Email, and SMS messages.
86
88
87
89
Example use cases:
@@ -92,13 +94,13 @@ Custom events and tags sent from Segment are automatically populated within Airs
92
94
93
95
## Group
94
96
95
-
For more information about the [group API call](https://segment.com/docs/connections/spec/group/) review the Segment spec.
97
+
For more information about the Group API call review the Segment [Group](/docs/connections/spec/group/) spec.
96
98
97
99
When you call `group`, the integration sets either Airship tags or attributes for
98
-
corresponding Segment traits. A *named user* must exist in Airship for the corresonding
100
+
corresponding Segment traits. A *named user* must exist in Airship for the corresponding
99
101
value of `userID` in Segment.
100
102
101
-
**UserID in Segment group API call**
103
+
### UserID in Segment group API call
102
104
103
105
```
104
106
{
@@ -108,7 +110,7 @@ value of `userID` in Segment.
108
110
}
109
111
```
110
112
111
-
**Named user in the correspnding Airship payload***
113
+
### Named user in the corresponding Airship payload
112
114
```
113
115
{
114
116
"audience": {
@@ -122,7 +124,7 @@ Airship tags are set for those Segment traits that contain a boolean value (eith
122
124
or `false`). All tags from `group` API calls are added to the `segment-integration-group` tag
123
125
group.
124
126
125
-
**A Segment group call containing boolean traits**
127
+
### A Segment group call with boolean traits
126
128
127
129
```
128
130
...
@@ -134,7 +136,7 @@ group.
134
136
...
135
137
```
136
138
137
-
**Setting the corresponding Airship tags**
139
+
### Setting the corresponding Airship tags
138
140
139
141
```
140
142
...
@@ -149,7 +151,7 @@ group.
149
151
150
152
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 (_).
151
153
152
-
**A Segment group call containing non-boolean traits**
154
+
### A Segment group call with non-boolean traits
153
155
154
156
```
155
157
...
@@ -165,7 +167,7 @@ For Segment traits that contain values of other types, such as numeric or text,
165
167
...
166
168
```
167
169
168
-
**Setting the corresponding Airship attributes**
170
+
### Setting the corresponding Airship attributes
169
171
```
170
172
...
171
173
"attributes": [
@@ -196,12 +198,12 @@ For Segment traits that contain values of other types, such as numeric or text,
196
198
...
197
199
```
198
200
199
-
#Leveraging this data in Airship
201
+
## Leverage this data in Airship
200
202
201
203
The following guides further explain the different ways of leveraging this data with Airship.
202
204
203
-
*[Cloud-mode Custom Events vs Audience Tags](https://docs.airship.com/guides/interaction/custom-events/#custom-events-vs-audience-tags)
204
-
*[Message Targeting with Tags](https://docs.airship.com/guides/audience/tags-named-users/)
205
-
*[Creating a Segment with Tags](https://docs.airship.com/tutorials/audience/segments-builder/)
206
-
*[Message Automation with Event Triggering](https://docs.airship.com/tutorials/orchestration/automation/automation/)
207
-
*[Message Personalization with Attributes](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/)
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"}
0 commit comments