# Airship

[Airship](https://www.airship.com/) is an app experience platform that lets you create and deliver powerful in-app experiences with the help of engaging, personalized content and actionable customer insights.

RudderStack supports Airship as a destination to which you can seamlessly send your event data.

Find the open-source transformer code for this destination in our [GitHub repository](https://github.com/rudderlabs/rudder-transformer/tree/master/v0/destinations/airship).

## Getting started

Before configuring Airship as a destination in RudderStack, verify if the source platform is supported by referring to the table below:

| **Connection Mode** | **Web**       | **Mobile**    | **Server**    |
| ------------------- | ------------- | ------------- | ------------- |
| **Device mode**     | -             | -             | -             |
| **Cloud mode**      | **Supported** | **Supported** | **Supported** |

To know more about the difference between cloud mode and device mode in RudderStack, refer to the [RudderStack Connection Modes](https://rudderstack.com/docs/rudderstack-cloud/rudderstack-connection-modes/) guide.

Once you have confirmed that the source platform supports sending events to Airship, follow these steps:

1. From your [RudderStack dashboard](https://app.rudderstack.com/), add the source. Then, from the list of destinations, select **Airship**.
2. Assign a name to your destination and click on **Next**.

### Connection settings

To successfully configure Airship as a destination, you will need to configure the following settings:

![Airship connection settings](/files/UvDY7OjVAYkTnJUQTi5U)

* **API Key**: Enter your Airship token which is required by RudderStack to communicate with your Airship project and authenticate all the supported event calls, that is, [`identify`](#identify), [`track`](#track), and [`group`](#group).

For detailed steps on obtaining the API key, refer to the [FAQ](#faq) section below.

* **App Key**: Enter your Airship project's app key which is required for the [`track`](#track) calls. You can obtain the app key by going to **Settings** > **Project Details** in your Airship dashboard.

For detailed steps on obtaining the Airship app key, refer to the [FAQ](#faq) section below.

* **EU data center**: Enable this setting if you've implemented your app in Airship's European data center.

If you're unsure which data center you are on, reach out to [Airship support](mailto:%20docs@rudderstack.com).

## Identify

The `identify` call lets you uniquely identify a user and record any associated traits about them like their name, email, etc.

For information on the `identify` call, refer to the [RudderStack API Specification](https://www.rudderstack.com/docs/rudderstack-api/api-specification/rudderstack-spec/identify/) guide.

A sample `identify` call is shown below:

```javascript
rudderanalytics.identify("1hKOmRA4el9Zt1WSfVJIVo4GRlm", {
  likes_movies: true,
  favorite_color: "purple",
  age: 13
});
```

In the above code snippet, RudderStack sends the Boolean values to Airship as [tags](https://docs.airship.com/api/ua/#operation-api-named_users-tags-post), whereas the non-Boolean values are sent as [attributes](https://docs.airship.com/api/ua/#operation-api-named_users-named_user_id-attributes-post).

RudderStack maps some reserved traits to the predefined Airship attributes. Refer to the [Traits mapping](#traits-mapping) section below for more information.

### Tags

To successfully assign tags to Airship using the RudderStack `identify` events, you must create a tag group with the group key set to `rudderstack_integration` in Airship.

For more information on creating a tag group in Airship, refer to the [FAQ](#faq) section below.

This integration supports `identify` traits of type Boolean only. Airship adds tags for the traits that are set to `true` and removes tags for the traits set to `false`.

### Attributes

For `identify` traits that are not mapped to any predefined or custom-defined Airship attributes, you must create and enable those attributes in the Airship dashboard.

Refer to the [FAQ](#faq) section below for more information on creating and enabling attributes in Airship.

## Track

The [`track`](https://www.rudderstack.com/docs/rudderstack-api/api-specification/rudderstack-spec/track/) call lets you capture user events along with the properties associated with them.

RudderStack sends the `track` events to Airship via their [Custom Events API](https://docs.airship.com/api/ua/#operation-api-custom-events-post). You can use the event properties to personalize and trigger specific messages for your audience.

Your Airship project's **App Key** is required for authenticating the `track` calls.

A sample `track` call is shown below:

```javascript
rudderanalytics.track("Product Clicked", {
  description: "Shoes viewed",
  brand: "Sneakers",
  colors: ["red", "blue"],
  items: [{
      text: "New Balance Sneakers",
      price: "$69.95",
    },
    {
      text: "G.I. Joe Sneakers",
      price: "$99.95",
    },
  ],
});
```

The event name sent to Airship must not contain any upper case characters. Otherwise, it is rejected with a `400` status code. RudderStack handles this by converting any upper case characters to lower case and replacing any spaces with an underscore(`_`).

In the snippet above, the event name `Product Clicked` is automatically converted to `product_clicked` before sending to Airship.

RudderStack also maps some event properties to the Airship properties before sending them over to Airship. For more information, refer to the [Supported mappings](#supported-mapping) section below.

## Group

The [`group`](https://www.rudderstack.com/docs/rudderstack-api/api-specification/rudderstack-spec/group/) call lets you link an identified user with a group such as a company, organization, or an account, and record any traits associated with that group, e.g., company name, number of employees, etc.

A sample `group` call is shown below:

```javascript
rudderanalytics.group(
  {
  userId: "1hKOmRA4el9Zt1WSfVJIVo4GRlm",
  likes_movies: true,
  age: 13,
  }
);
```

In the above code snippet, RudderStack sends the Boolean values to Airship as [tags](https://docs.airship.com/api/ua/#operation-api-named_users-tags-post), whereas the non-Boolean values are sent as [attributes](https://docs.airship.com/api/ua/#operation-api-named_users-named_user_id-attributes-post).

This integration supports `group` traits of type Boolean only. Airship adds tags for the traits that are set to `true` and removes tags for the traits set to `false`.

To successfully assign tags to Airship using the RudderStack `group` events, you must create a tag group with the group key set to `rudderstack_integration_group` in Airship. Similarly, you need to create the relevant attribute identifiers in Airship to set the attributes on the named users.

For more information on creating a tag group or attributes in Airship, refer to the [FAQ](#faq) section below.

## Supported mappings

RudderStack maps the following event properties to the Airship properties before sending them over to Airship.

| RudderStack property | Airship property   | Presence |
| -------------------- | ------------------ | -------- |
| `userId`             | `named_user_id`    | Required |
| `event`              | `name`             | Required |
| `properties`         | `properties`       | Optional |
| `value`              | `value`            | Optional |
| `interactionId`      | `interaction_id`   | Optional |
| `interactionType`    | `interaction_type` | Optional |
| `sessionId`          | `session_id`       | Optional |
| `transaction`        | `transaction`      | Optional |
| `timestamp`          | `occurred`         | Optional |

### Traits mapping

| RudderStack trait    | Airship attribute  |
| -------------------- | ------------------ |
| `address.city`       | `city`             |
| `address.country`    | `country`          |
| `address.postalcode` | `zipcode`          |
| `address.state`      | `region`           |
| `createdAt`          | `account_creation` |
| `firstName`          | `first_name`       |
| `lastName`           | `last_name`        |
| `name`               | `full_name`        |
| `phone`              | `mobile_phone`     |

## FAQs

### Where can I obtain the Airship API key?

The Airship API key is required so that RudderStack can communicate with your Airship project. This is a mandatory field to set up the integration.

To obtain your Airship project's API key, follow these steps:

1. In your Airship dashboard, go to **Settings**.
2. In the **Project configuration** window, go to **Tokens** and click on **Manage**.
3. Then, click on **Create token**.
4. Assign a name for your token. Under **Role**, select **All access** from the dropdown, as shown:

![Airship project token](/files/FN5DJeIH9kVmJNRVUMot)

1. Once the token is created, copy and secure the credentials and click on **Got it**.

### Where can I obtain the Airship App Key?

To obtain your Airship project's app key, follow these steps:

1. In your Airship dashboard, go to **Settings**.
2. In the **Project configuration** window, look for the **Project Details** pane on the right side.

You will find your project's app key listed here.

### How do I create a custom tag group in Airship?

To create a tag group in Airship, follow these steps:

1. Go to **Settings** > **Project configuration** > **Tag Groups** and click on **Manage**.
2. Click on **Create Tag Group** and enter the following settings:
   * **Name**: Enter the name for the tag group.
   * **Description**: Set additional information about the tag group in this field.
   * **Group Key**: Assign a unique ID for the tag group in this field. For example, to assign tags using the RudderStack `identify` events, you can set this to `rudderstack-integration`. For assigning tags using the `group` events, set this to `rudderstack-integration-group`.

For more information, refer to the [Airship documentation](https://docs.airship.com/guides/messaging/user-guide/audience/segmentation/tags/#creating-custom-tag-groups).

### How do I create and enable attributes in Airship?

For `identify` traits that are not mapped to any predefined or custom-defined Airship attributes, you must create and enable those attributes in the Airship dashboard. To do so, follow these steps:

1. Go to your Airship dashboard.
2. Navigate to **Audience** > **Attributes**.
3. Click on **Create Attribute**.
4. Enter the **Attribute ID**, **Name**, and select the attribute **Type**.
5. Finally, click on **Add**.

![Airship new attributes](/files/OeqivqQobmBRz6JXdEKX)

## Contact us

For queries on any of the sections covered in this guide, you can [contact us](mailto:%20docs@rudderstack.com) or start a conversation in our [Slack](https://rudderstack.com/join-rudderstack-slack-community) community.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rudderlabs.gitbook.io/rudderlabs-1/docs/destinations/marketing/airship.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.