Skip to content

Update information about the Airship destination and source #2025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/_data/catalog/destination_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination categories last updated 2021-10-13
# destination categories last updated 2021-10-18
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
75 changes: 73 additions & 2 deletions src/_data/catalog/destinations.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# destination data last updated 2021-10-13
# destination data last updated 2021-10-18
items:
- display_name: 2mee
name: 2mee
Expand Down Expand Up @@ -1035,7 +1035,7 @@ items:
identify: true
group: true
alias: false
page: true
page: false
platforms:
browser: true
mobile: true
Expand Down Expand Up @@ -6059,6 +6059,71 @@ items:
page](https://fly.customer.io/account/customerio_integration).
required: true
label: Site ID
- display_name: Customer.io Actions
name: Customer.io Actions
slug: customer-io-actions
hidden: false
url: connections/destinations/catalog/customer-io-actions
previous_names:
- Actions Customerio
- Customer.io Actions
website: https://customer.io
status: PUBLIC_BETA
categories:
- Email Marketing
logo:
url: https://cdn.filepicker.io/api/file/GyZ581zaSTmv9T1ivLE0
mark:
url: https://cdn.filepicker.io/api/file/w8zEnnazRwaPhGG4lLux
methods:
track: true
identify: true
group: true
alias: true
page: true
platforms:
browser: true
mobile: false
server: true
components: []
browserUnbundlingSupported: false
browserUnbundlingPublic: false
replay: false
connection_modes:
device:
web: false
mobile: false
server: false
cloud:
web: false
mobile: false
server: false
summary: No connection mode information available.
cmode_type: none
case: '0'
settings:
- name: accountRegion
type: select
defaultValue: US 🇺🇸
description: Learn about [Account Regions](https://customer.io/docs/data-centers/).
required: true
label: Account Region
- name: apiKey
type: string
defaultValue: ''
description: >-
Customer.io API key. This can be found on your [API Credentials
page](https://fly.customer.io/settings/api_credentials).
required: true
label: API Key
- name: siteId
type: string
defaultValue: ''
description: >-
Customer.io site ID. This can be found on your [API Credentials
page](https://fly.customer.io/settings/api_credentials).
required: true
label: Site ID
- display_name: CustomerSuccessBox
name: CustomerSuccessBox
slug: customersuccessbox
Expand Down Expand Up @@ -17993,6 +18058,12 @@ items:
cmode_type: cloud-only
case: '5'
settings:
- name: endpoint
type: select
defaultValue: https://api.segment.io
description: Choose the endpoint corresponding to your region.
required: true
label: Endpoint
- name: repeatKeys
type: array
defaultValue: []
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/source_categories.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# source cateogries last updated 2021-10-13
# source cateogries last updated 2021-10-18
items:
- display_name: A/B Testing
slug: a-b-testing
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/sources.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# sources last updated 2021-10-13
# sources last updated 2021-10-18
items:
- display_name: .NET
slug: net
Expand Down
2 changes: 1 addition & 1 deletion src/_data/catalog/warehouse_papi.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
# warehouse data last updated 2021-10-13
# warehouse data last updated 2021-10-18
items:
- display_name: Azure SQL Data Warehouse
slug: azuresqldw
Expand Down
182 changes: 149 additions & 33 deletions src/connections/destinations/catalog/airship/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@ rewrite: true
title: Airship Destination
---

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

[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.

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.

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`.

[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.

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

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

Follow these steps to configure the integration

1. From the Segment web app, click **Catalog**.
2. Search for "Airship" in the Catalog, select it, and choose which of your sources to connect the destination to.
3. Enter the "API Key" into your Segment Settings UI.
* 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.
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).
1. Log in to your Segment workspace
2. Go to the **Catalog** and click the **Destinations** tab.
3. Find the `Airship` destination (under *SMS & Push Notifications*), click the *Airship* tile and then click the *Configure Airship* button.
4. In the *Select Source* dialog, select a source and click *Confirm Source*.
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])).
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).
4. For `identify` events, first [set up a tag group within Airship](https://docs.airship.com/partners/segment/#tag-group).
5. For `attributes`, first [predefine them in Airship](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/#add-attributes).

## Requirements
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. This would prevent you from effectively issuing automated messages or attaching user attributes from Segment within Airship
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.

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.

## Identify

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:
To understand the Identify API call, review the Segment [Identify](/docs/connections/spec/identify/) spec. An example call looks like:

```
analytics.identify('jill', {
Expand All @@ -44,20 +50,25 @@ analytics.identify('jill', {
});
```

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.
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`.

### Segment Identify Events to Airship Attributes

**Segment Identify Events to Airship Tags**
Airship Tags are used for profile enrichment, message triggering, segment building, and user analytics.
Airship attributes are used for profile enrichment, message personalization, segment building, and user analytics.

Example Use cases:
* Identify event sets an Airship tag on a user is flagged as liking a specific product category
* Identify event sets an Airship tag on a user registers for an account
## Segment Identify Events to Airship Tags

Airship tags are used for profile enrichment, message triggering, segment building, and user analytics.

Example use cases in Airship:
* An `identify` event sets a tag to mark the user as *liking a specific product category*
* An `identify` event sets an attribute on a user who *registers for an account*

## Track

Use this Destination to send `Track` events to Airship for message triggering and analytics.
Use this destination to send `track` events to Airship for message triggering and analytics.

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:
For more information about the Track API call review the Segment [Track]((/docs/connections/spec/track/)) spec. An example call looks like:

```
analytics.track('Product Clicked', {
Expand All @@ -69,25 +80,130 @@ analytics.track('Product Clicked', {
});
```

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

### Segment Track Events to Airship Custom Events

Airship custom events are used to trigger automated messages for Mobile App, Web Notifications, Email, and SMS messages.

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.
Example use cases:
* The `track` event triggers an Airship custom event on a user who has `abandoned a cart` and an Airship message is triggered for reengagement
* The `track` event triggers an Airship custom event on a user who has `uninstalled the app` to trigger an SMS, Email, or Web Notification

**Segment Track Events to Airship Custom Events**
Airship Custom Events are used to trigger automated messages for Mobile App, Web Notifications, Email, and SMS messages.
Custom events and tags sent from Segment are automatically populated within Airship Performance Analytics reporting dashboards.

Example Use cases:
* Track event triggers an Airship Custom Event on a user who has abandoned cart and an Airship message is triggered for reengagement
* Track event triggers an Airship Custom Event on a user who uninstalled the app to trigger an SMS, Email, or Web Notification
## Group

Custom Events and Tags sent from Segment are automatically populated within Airship Performance Analytics reporting dashboards.
For more information about the Group API call review the Segment [Group](/docs/connections/spec/group/) spec.

When you call `group`, the integration sets either Airship tags or attributes for
corresponding Segment traits. A *named user* must exist in Airship for the corresponding
value of `userID` in Segment.

### UserID in Segment group API call

```
{
...
"userId": "test-user-69w86c"
...
}
```

### Named user in the corresponding Airship payload
```
{
"audience": {
"named_user_id": "test_user-69w86c"
},
...
}
```

Airship tags are set for those Segment traits that contain a boolean value (either `true`
or `false`). All tags from `group` API calls are added to the `segment-integration-group` tag
group.

### A Segment group call with boolean traits

```
...
"traits:" {
"hiring": true,
"has-remote-employees": false,
...
}
...
```

### Setting the corresponding Airship tags

```
...
"add": {
"segment-integration-group": ["hiring"]
},
"remove": {
"segment-integration-group": ["has-remote-employees"]
}
...
```

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 (_).

### A Segment group call with non-boolean traits

```
...
"traits": {
"name": "Initech",
"industry": "Technology",
"employees": 329,
"address": {
"city": "Portland",
...
}
}
...
```

### Setting the corresponding Airship attributes
```
...
"attributes": [
{
"action": "set",
"key": "company",
"value": "Initech",
...
},
{
"action": "set",
"key": "airship_segment_group_industry",
"value": "Technology",
...
},
{
"action": "set",
"key": "airship_segment_group_employees",
"value": 329,
...
},
{
"action": "set",
"key": "airship_segment_group_address_city",
"value": "Portland",
...
}
...
```

# Leveraging this data in Airship
## Leverage this data in Airship

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

* [Cloud-mode Custom Events vs Audience Tags](https://docs.airship.com/guides/interaction/custom-events/#custom-events-vs-audience-tags)
* [Message Targeting with Tags](https://docs.airship.com/guides/audience/tags-named-users/)
* [Creating a Segment with Tags](https://docs.airship.com/tutorials/audience/segments-builder/)
* [Message Automation with Event Triggering](https://docs.airship.com/tutorials/orchestration/automation/automation/)
* [Cloud-mode Custom Events vs Audience Tags](https://docs.airship.com/guides/interaction/custom-events/#custom-events-vs-audience-tags){:target="_blank"}
* [Message Targeting with Tags](https://docs.airship.com/guides/audience/tags-named-users/){:target="_blank"}
* [Creating a Segment with Tags](https://docs.airship.com/tutorials/audience/segments-builder/){:target="_blank"}
* [Message Automation with Event Triggering](https://docs.airship.com/tutorials/orchestration/automation/automation/){:target="_blank"}
* [Message Personalization with Attributes](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/){:target="_blank"}
10 changes: 7 additions & 3 deletions src/connections/sources/catalog/cloud-apps/airship/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: Airship Source
---

[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.
[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.

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

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

> success ""
> **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!
Expand All @@ -28,6 +28,10 @@ This Source integration is maintained by Airship. For any issues with the source
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.

<table>
<tr>
<td>Attribute Operation</td>
<td>Indicates a change in the device's attributes. Because attribute operations are related to a device they have a *device* field.</td>
</tr>
<tr>
<td>Open</td>
<td>Occurs when a user opens your app.</td>
Expand Down