# Airship (Actions) Destination

## Destination Info

* Accepts [Page](/docs/segment/connections/spec/page), [Alias](/docs/segment/connections/spec/alias), [Group](/docs/segment/connections/spec/group), [Identify](/docs/segment/connections/spec/identify), [Track](/docs/segment/connections/spec/track) calls.
* Refer to it as **Airship (Actions)** in the [Integrations object.](/docs/segment/guides/filtering-data/#filtering-with-the-integrations-object)
* This integration is **partner owned.** Please reach out to the partner's support for any issues.

[Airship](https://app.segment.com/airship/destinations/catalog/actions-airship) provides an end-to-end solution for capturing value across the entire customer app lifecycle — from acquisition and activation to engagement and loyalty. It starts with Airship's market-leading app store optimization (ASO) solutions promoting app discovery and downloads. Then the unified journey orchestration, content creation and experimentation solutions kick in. App teams can quickly design, deploy and iterate no-code native app experiences and cross-channel campaigns — bridging inside-the-app experiences with outside-the-app messaging.

Airship maintains this destination. For any issues with the destination, [contact the Airship Support team](mailto:support@airship.com).

> \[!TIP]
>
> **Good to know**: This page is about the [Actions-framework](/docs/segment/connections/destinations/actions/) Airship Segment destination. There's also a page about the [non-Actions Airship destination](/docs/segment/connections/destinations/catalog/airship/). Both of these destinations receive data from Segment.

## Benefits of Airship (Actions) vs Airship Classic

Airship (Actions) provides the following benefits over the classic Airship destination:

* **Flexibility**. Complete flexibility for mapping your data from any Segment event type to one of three Airship endpoints. Make optimal use of data from Segment to trigger Automations, audience segmentation, or to personalize end-users in-app experiences and messages.
* **Additional functionality**. Supports email registration, named user association, as well as delete for GDPR compliance. This is in addition to the previously supported custom events, tag management, and attributes.
* **Reporting**. Better and more meaningful feedback from the Airship API. This integration calls the Airship API directly, so the endpoint response shows precisely how the integration is performing.

## Getting started

1. From the Segment web app, navigate to **Connections > Catalog**, and select the **Destinations** tab in the catalog.
2. Search for *Airship (Actions)* and select it.
3. Click **Configure Airship (Actions)**.
4. Select an existing Source to connect to Airship (Actions).
5. Name the destination and choose between filling in the settings manually or copying from an existing instance.
6. Click **Create Destination**.
7. Enter your Access Token and App Key. You can get your access token and app key by going to your Airship project and navigating to **Settings > Partner Integrations** and selecting Segment. Following the instructions there will create a Tag Group, Attributes, and provide the Access Token and App Key.
8. Select the appropriate data center.

## Destination Settings

| Field        | Description                                                                   | Required | Type     |
| ------------ | ----------------------------------------------------------------------------- | -------- | -------- |
| Access Token | Create in the Airship Go dashboard in Settings->Partner Integrations->Segment | Yes      | password |
| App Key      | The App Key identifies the Airship Project to which API requests are made.    | Yes      | string   |
| Data Center  | US or EU                                                                      | Yes      | select   |

## Available Presets

Airship (Actions) has the following presets

| Preset Name    | Trigger                 | Default Action |
| -------------- | ----------------------- | -------------- |
| Custom Events  | Event type = "track"    | Custom Events  |
| Set Attributes | Event type = "identify" | Set Attributes |

## Available Actions

Build your own Mappings. Combine supported [triggers](/docs/segment/connections/destinations/actions/#components-of-a-destination-action) with the following Airship-supported actions:

> \[!NOTE]
>
> Individual destination instances have support a maximum of 50 mappings.

* [Custom Events](#custom-events)
* [Manage Tags](#manage-tags)
* [Set Attributes](#set-attributes)
* [Register And Associate](#register-and-associate)

### Custom Events

Set Custom Events on Users

Custom Events is a **Cloud** action. The default Trigger is `type = "track"`

| Field                 | Description                                                                                 | Required | Type     |
| --------------------- | ------------------------------------------------------------------------------------------- | -------- | -------- |
| Airship Named User ID | The identifier assigned in Airship as the Named User                                        | Yes      | STRING   |
| Name                  | Event Name                                                                                  | Yes      | STRING   |
| Occurred              | When the event occurred.                                                                    | Yes      | DATETIME |
| Event Properties      | Properties of the event                                                                     | No       | OBJECT   |
| Batch Data to Airship | If true, Segment will batch events before sending to Airship. Limit 100 events per request. | No       | BOOLEAN  |

### Manage Tags

Associate tags with users in your audience for segmentation and automation

Manage Tags is a **Cloud** action.

| Field                 | Description                                                                                                                                                                     | Required | Type   |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ |
| Airship Named User ID | The identifier assigned in Airship as the Named User                                                                                                                            | Yes      | STRING |
| Tag Name              | Tag name to add or remove. Values for each tag should be boolean only. A true value creates a tag, a false value removes a tag. Non-boolean values will be ignored.             | No       | OBJECT |
| Tag Group             | The Tag Group to sync your tags to. This defaults to\`segment-integration\` but can be overridden with this field. Note: the Tag Group used must be valid and exist in Airship. | Yes      | STRING |

### Set Attributes

Set user attributes in Airship with data from Segment. Some common user attributes are predefined in the attributes field, however note that all must be created in Airship before use. More information here: https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/attributes/project/#adding-attributes

Set Attributes is a **Cloud** action. The default Trigger is `type = "identify"`

| Field                 | Description                                                                                                           | Required | Type     |
| --------------------- | --------------------------------------------------------------------------------------------------------------------- | -------- | -------- |
| Airship Named User ID | The identifier assigned in Airship as the Named User                                                                  | Yes      | STRING   |
| Occurred              | When the Trait was set                                                                                                | Yes      | DATETIME |
| Attributes            | User Attributes. Attributes should exist in Airship in order to be set, including the predifined ones defaulted here. | No       | OBJECT   |

### Register And Associate

Register an Email address or SMS number and associate it with a Named User ID.

Register And Associate is a **Cloud** action. The default Trigger is `type = "track" and event="Address Registered"`

| Field                 | Description                                                                 | Required | Type   |
| --------------------- | --------------------------------------------------------------------------- | -------- | ------ |
| Channel Type          | Email (default) or SMS                                                      | No       | STRING |
| SMS Sender            | A long or short code the app is configured to send from (if using for SMS). | No       | STRING |
| Airship Named User ID | The identifier assigned in Airship as the Named User                        | No       | STRING |
| Locale                | Locale includes country and language                                        | No       | STRING |
| Timezone              | Timezone                                                                    | No       | STRING |
| Registration Type     | Classic or Double                                                           | No       | STRING |
| Channel               | Information about the email registration.                                   | Yes      | OBJECT |

## Named User ID

Named User is an Airship concept for identifying users and associating them with devices and delivery addresses. For more information, see [Airship | Named Users](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/named-users/). This integration does not perform the association of a Named User to a delivery address, configure that in either the mobile/web SDK or through a custom workflow out of band from this integration.

## Engage

You can send computed traits and audiences generated using [Engage](/docs/segment/engage) to this destination as a **user property**. To learn more about Engage, schedule a [demo](https://segment.com/contact/demo).

For user-property destinations, an [identify](/docs/segment/connections/spec/identify/) call is sent to the destination for each user being added and removed. The property name is the snake\_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property `order_completed_last_30days: true`. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to `false`.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

> \[!NOTE]
>
> Real-time audience syncs to Airship (Actions)  may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.

## Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

| Field        | Description                                                                   | Required | Type     |
| ------------ | ----------------------------------------------------------------------------- | -------- | -------- |
| Access Token | Create in the Airship Go dashboard in Settings->Partner Integrations->Segment | Yes      | password |
| App Key      | The App Key identifies the Airship Project to which API requests are made.    | Yes      | string   |
| Data Center  | US or EU                                                                      | Yes      | select   |
