# Events Reference

This reference lists all default and predefined events with their properties, use cases, and paths.

This page organizes events by type and channel. See also:
* [Events user guide](https://www.airship.com/docs/guides/audience/events/events/)
* [API: Activity Audience Object](https://www.airship.com/docs/developer/rest-api/ua/schemas/event-segmentation/#activityobject)

For a complete list of events, see our [RTDS API Reference](https://www.airship.com/docs/developer/rest-api/connect/schemas/events/).

## Default events

Below are lists of all available default events per channel. Default events do not require additional configuration.

### App and Web events

The events in this section are recorded for both mobile apps and web.

#### Scenes

Your project includes these default Scene events:

Scene displayed — `scene_displayed`
: User viewed at least the first screen in a Scene.

Scene completed — `scene_completed`
: User viewed all the screens in a Scene.

Scene incomplete — `scene_incomplete`
: User dismissed a Scene before the last screen was viewed.

The following table describes properties for Scene events:

| Property | Use case | Path |
| --- | --- | --- |
| Push ID | Received a Scene associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_msg/push_id` |
| Campaign Category | Received a Scene from a push with a specific campaign category. | `$._msg.campaigns.categories[*]` |

#### Surveys

Your project includes these default events for survey content in Scenes:

Survey displayed — `survey_displayed`
: Scene containing questions or NPS survey was displayed on a user's device.

Survey submitted — `survey_submitted`
: Scene containing questions or NPS survey was submitted by a user.

Survey not submitted — `survey_not_submitted`
: Scene containing questions or NPS survey was dismissed without being submitted.

The following table describes properties for survey events:

| Property | Use case | Path |
| --- | --- | --- |
| Push ID | Received a survey associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_msg/push_id` |
| Survey type | Received a survey associated with a survey type `nps` or `user_feedback`. | `/_msg/context/state/form/response_type` |
| Campaign Category | Received survey from a push with a specific campaign category. | `$._msg.campaigns.categories[*]` |

### App events

The events in this section are recorded for mobile apps.

#### First seen

Your project includes this default app event:

<dl>
<dt>First seen — <code>first_seen</code></dt>
<dd>User opted in to notifications or opened your app for the first time.</dd>
</dl>
<p>The following table describes properties for the first seen event:</p>
<table>
  <thead>
      <tr>
          <th>Property</th>
          <th>Use case</th>
          <th>Path</th>
      </tr>
  </thead>
  <tbody>
      <tr>
          <td>Platform</td>
          <td>Target users who were [first seen](https://www.airship.com/docs/reference/glossary/#first_seen_event_trigger) on a specific platform in a sequence.</td>
          <td><code>/_msg/platform</code></td>
      </tr>
  </tbody>
</table>

#### App open

Your project includes this default app open event:

App open — `app_open`
: User opened your mobile app. This event fires every time a user opens your app, including the first time. See also [First open](#first-open).

The following table describes properties for the app open event:

| Property | Use case | Path |
| --- | --- | --- |
| Push ID | Opened app as result of a specific [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_triggering_push/push_id` |
| Group ID | Opened app as result of a specific [Group ID](https://www.airship.com/docs/reference/glossary/#group_id). | `/_triggering_push/group_id` |
| Variant ID | Opened app as result of a specific A/B test variant. | `/_triggering_push/variant_id` |
| Campaign Category | Opened app as result of a push with a specific campaign category. | `/_triggering_push/campaigns/categories` |

#### First open

Your project includes this default first open event:

First open — `first_open`
: User first registered a channel in your app. This event fires only once per user, when a channel is first registered. Channel registration most commonly occurs immediately after the first app open but can happen at other times as well, For example, if channel registration was delayed. The [app open](#app-open) event fires on every app open, including the first.

The `first_open` event has no additional properties at this time.

#### Message received

Your project includes this default message received event:

Message received — `message_received`
: User was sent a message by Airship.

The following table describes properties for the message received event:

<table>
  <thead>
      <tr>
          <th>Property</th>
          <th>Use Case</th>
          <th>Path</th>
      </tr>
  </thead>
  <tbody>
      <tr>
          <td>Push ID</td>
          <td>Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id).</td>
          <td><code>/_msg/push_id</code></td>
      </tr>
      <tr>
          <td>Group ID</td>
          <td>Received message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id).</td>
          <td><code>/_msg/group_id</code></td>
      </tr>
      <tr>
          <td>Variant ID</td>
          <td>Received message as a member a specific A/B test variant.</td>
          <td><code>/_msg/variant_id</code></td>
      </tr>
      <tr>
          <td>Campaign Category</td>
          <td>Received message from a push with a specific campaign category.</td>
          <td><code>$._msg.campaigns.categories[*]</code></td>
      </tr>
  </tbody>
</table>

#### In-app messages

Your project includes these default in-app message events:

In-app message display — `in_app_message_display`
: In-app message was displayed on user's device.

In-app message resolution — `in_app_message_resolution`
: In-app message was cleared from the display, either by user action or timeout.

In-app message events have no properties at this time.

#### Message Center

Your project includes these default Message Center events:

Message Center delivered — `message_center_delivered`
: Message Center message was delivered to device.

Message Center read — `message_center_read`
: User viewed Message Center message.

Message Center deleted — `message_center_deleted`
: Message Center message was deleted by user.

The following table describes properties for Message Center events:

| Property | Use case | Path |
| --- | --- | --- |
| Push ID | Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_msg/push_id` |
| Group ID | Received message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id). | `/_msg/group_id` |
| Variant ID | Received message as a member of a specific A/B test variant. | `/_msg/variant_id` |
| Campaign Category | Received message from a push with a specific campaign category. | `/_msg/campaigns/categories` |

#### Message Center control

Your project includes this default Message Center control event:

Message Center control — `message_center_control`
: Message Center message was not sent to user because the user's channel or contact was held out of a push as part of an experiment.

The following table describes properties for the Message Center control event:

| Property | Use case | Path |
| --- | --- | --- |
| Push ID | Did not receive a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_msg/push_id` |
| Group ID | Did not receive a message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id). | `/_msg/group_id` |
| Variant ID | Did not receive a message as a member of a specific A/B test variant. | `/_msg/variant_id` |
| Campaign Category | Did not receive a message from a push with a specific campaign category. | `/_msg/campaigns/categories` |

### Web events

The events in this section are recorded for websites.

#### First seen

Your project includes this default web event:

<dl>
<dt>First seen — <code>first_seen</code></dt>
<dd>User opted in to notifications or opened your app for the first time.</dd>
</dl>
<p>The following table describes properties for the first seen event:</p>
<table>
  <thead>
      <tr>
          <th>Property</th>
          <th>Use case</th>
          <th>Path</th>
      </tr>
  </thead>
  <tbody>
      <tr>
          <td>Platform</td>
          <td>Target users who were [first seen](https://www.airship.com/docs/reference/glossary/#first_seen_event_trigger) on a specific platform in a sequence.</td>
          <td><code>/_msg/platform</code></td>
      </tr>
  </tbody>
</table>

#### Message received

Your project includes this default message received event:

Message received — `message_received`
: User was sent a message by Airship.

The following table describes properties for the message received event:

<table>
  <thead>
      <tr>
          <th>Property</th>
          <th>Use Case</th>
          <th>Path</th>
      </tr>
  </thead>
  <tbody>
      <tr>
          <td>Push ID</td>
          <td>Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id).</td>
          <td><code>/_msg/push_id</code></td>
      </tr>
      <tr>
          <td>Group ID</td>
          <td>Received message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id).</td>
          <td><code>/_msg/group_id</code></td>
      </tr>
      <tr>
          <td>Variant ID</td>
          <td>Received message as a member a specific A/B test variant.</td>
          <td><code>/_msg/variant_id</code></td>
      </tr>
      <tr>
          <td>Campaign Category</td>
          <td>Received message from a push with a specific campaign category.</td>
          <td><code>$._msg.campaigns.categories[*]</code></td>
      </tr>
  </tbody>
</table>

#### Engagement

Your project includes these default web engagement events:

Web click — `web_click`
: User clicked the web notification.

Web session — `web_session`
: User generated a [web session](https://www.airship.com/docs/reference/glossary/#web_session).

The following table describes properties for web engagement events:

| Property | Use case | Path |
| --- | --- | --- |
| Push ID | Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_triggering_push/push_id` |
| Group ID | Received message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id). | `/_triggering_push/group_id` |

### Email events

The events in this section are recorded for email.

#### First seen

Your project includes this default email event:

<dl>
<dt>First seen — <code>first_seen</code></dt>
<dd>User opted in to notifications or opened your app for the first time.</dd>
</dl>
<p>The following table describes properties for the first seen event:</p>
<table>
  <thead>
      <tr>
          <th>Property</th>
          <th>Use case</th>
          <th>Path</th>
      </tr>
  </thead>
  <tbody>
      <tr>
          <td>Platform</td>
          <td>Target users who were [first seen](https://www.airship.com/docs/reference/glossary/#first_seen_event_trigger) on a specific platform in a sequence.</td>
          <td><code>/_msg/platform</code></td>
      </tr>
  </tbody>
</table>

#### Delivery and opens

Your project includes these default email delivery and open events:

Email injection — `email_injection`
: The number of emails successfully sent from SparkPost to the email provider.

Email delay — `email_delay`
: Mailbox provider temporarily rejected an email. In general, this event indicates that the provider will attempt to resend the message.

Email bounce — `email_bounce`
: Email could not be delivered to an address.

Email delivered — `email_delivered`
: Remote email server acknowledged receipt of a message.

Initial open — `initial_open`
: User opened an email, rendering a tracking pixel at the top of the message.

Email open — `email_open`
: User opened an email, rendering a tracking pixel at the bottom of the message. This event only occurs when the entire email has loaded on screen.

The following table describes properties for email delivery and open events:

| Property | Use case | Path |
| --- | --- | --- |
| Sender | Received email from a specific email address. | `sender` |
| Subject | Received email with specific subject. | `subject` |
| Email address | Message targeted recipient's email address. | `email` |
| Push ID | Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_triggering_push/push_id` |
| Group ID | Received message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id). | `/_triggering_push/group_id` |
| Campaign Category | Received message associated with a specific campaign category. | `$._triggering_push.campaigns.categories[*]` |

#### Link clicks

Your project includes this default email click event:

Email click — `email_click`
: User clicked a tracked link in a message. Only HTTP and HTTPS links are tracked.

The following table describes properties for the email click event:

| Property | Use case | Path |
| --- | --- | --- |
| Sender | Received email from a specific email address. | `sender` |
| Subject | Received email with specific subject. | `subject` |
| Link URL | User clicked on a specific email link. | `link_url` |
| Link Name | User clicked on a [named email link](https://www.airship.com/docs/guides/messaging/messages/content/email/email/#link-names). | `link_name` |
| Email address | Message targeted recipient's email address. | `email` |
| Push ID | Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_triggering_push/push_id` |
| Group ID | Received message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id). | `/_triggering_push/group_id` |
| Campaign Category | Received message associated with a specific campaign category. | `$._triggering_push.campaigns.categories[*]` |

#### Unsubscribe

Your project includes this default email unsubscribe event:

Email unsubscribe — `email_unsubscribe`
: User clicked an unsubscribe link in an email you sent.

The following table describes properties for the email unsubscribe event:

| Property | Use case | Path |
| --- | --- | --- |
| Unsubscribe | User unsubscribes via the link that you provided. **Note**: There is only one unsubscribe event type (`link_unsubscribe`) | `unsubscribe_event_type` |
| Push ID | Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_triggering_push/push_id` |
| Group ID | Received message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id). | `/_triggering_push/group_id` |
| Campaign Category | Received message associated with a specific campaign category. | `$._triggering_push.campaigns.categories[*]` |

### SMS events

The events in this section are recorded for SMS.

#### First seen

Your project includes this default SMS event:

<dl>
<dt>First seen — <code>first_seen</code></dt>
<dd>User opted in to notifications or opened your app for the first time.</dd>
</dl>
<p>The following table describes properties for the first seen event:</p>
<table>
  <thead>
      <tr>
          <th>Property</th>
          <th>Use case</th>
          <th>Path</th>
      </tr>
  </thead>
  <tbody>
      <tr>
          <td>Platform</td>
          <td>Target users who were [first seen](https://www.airship.com/docs/reference/glossary/#first_seen_event_trigger) on a specific platform in a sequence.</td>
          <td><code>/_msg/platform</code></td>
      </tr>
  </tbody>
</table>

#### Delivery status

Your project includes these default SMS delivery status events:

SMS dispatched — `sms_dispatched`
: SMS message was dispatched and accepted for delivery by the short message service center.

SMS delivered — `sms_delivered`
: SMS message was delivered.

SMS aborted — `sms_aborted`
: SMS message was aborted before reaching short message service center.

SMS expired — `sms_expired`
: SMS message expired before delivery to the short message service center.

SMS rejected — `sms_rejected`
: SMS message was rejected by short message service center.

SMS failed — `sms_failed`
: SMS message failed to be delivered.

SMS undeliverable — `sms_undeliverable`
: SMS message could not be delivered.

SMS unknown — `sms_unknown`
: SMS message was delivered to the short message service center, but no delivery receipt has been received or a delivery receipt that could not be interpreted was received.

The following table describes properties for SMS delivery status events:

| Property | Use case | Path |
| --- | --- | --- |
| Vendor Delivery ID | Received SMS from specific vendor. | `vendorDeliveryId` |
| Sender ID | Received SMS from specific sender. | `sender` |
| Error code | SMS resulted in specific error code. | `error_code` |
| Push ID | Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_triggering_push/push_id` |

#### Short Link click

Your project includes this default Short Link click event:

Short Link click — `short_link_click`
: User clicked the Short Link in the sent message.

The following table describes properties for the Short Link click event:

| Property | Use case | Path |
| --- | --- | --- |
| Original Url | User clicked on a shortened link in a message. | `original_url` |
| Push ID | Received a message associated with a [Push ID](https://www.airship.com/docs/reference/glossary/#push_id). | `/_triggering_push/push_id` |
| Group ID | Received message associated with a [Group ID](https://www.airship.com/docs/reference/glossary/#group_id). | `/_triggering_push/group_id` |

## Predefined events

Below are groupings of all available predefined events. See the templates information in our [Custom Events](https://www.airship.com/docs/sdk-topics/custom-events/) SDK documentation for implementation details.

Before you can segment on predefined events you must [activate them for segmentation](https://www.airship.com/docs/guides/audience/events/manage/) in the dashboard. Predefined events are [Custom Events](https://www.airship.com/docs/reference/glossary/#custom_event), so you can define additional properties for them if you like, as long as you declare the properties in the SDK.

> **Note:** **Transaction ID** is not currently supported with event segmentation for predefined events.


### Registration

Your project includes this predefined registration event:

Registered for account — `registered_account`
: User registered for an account.

It has a single string property, `category`.

### Authentication

Your project includes these predefined authentication events:

Logged in — `logged_in`
: User logged into their account.

Logged out — `logged_out`
: User logged out of their account.

The following table describes properties for authentication events:

| Property  | Type   |
|-----------|--------|
| `user_id` | String |
| `type`    | String |

### Shopping

Your project includes these predefined shopping events:

Browsed — `browsed`
: User browsed a product.

Starred product — `starred_product`
: User starred or favorited a product.

Shared product — `shared_product`
: User shared a product.

Added to cart — `added_to_cart`
: User added a product to their shopping cart.

Purchased — `purchased`
: User completed a purchase.

The following table describes properties for shopping events:

| Property      | Type    |
|---------------|---------|
| `category`    | String  |
| `id`          | String  |
| `description` | String  |
| `brand`       | String  |
| `new_item`    | Boolean |

### Wishlist

Your project includes these predefined wishlist events:

Added to wishlist — `add_to_wishlist`
: User added a product to their wishlist.

Removed from wishlist — `remove_from_wishlist`
: User removed a product from their wishlist.

The following table describes properties for wishlist events:

| Property        | Type    |
|-----------------|---------|
| `wishlist_id`   | String  |
| `wishlist_name` | String  |
| `category`      | String  |
| `id`            | String  |
| `description`   | String  |
| `brand`         | String  |
| `new_item`      | Boolean |

### Content

Your project includes these predefined content events:

Browsed content — `browsed_content`
: User browsed content.

Consumed content — `consumed_content`
: User consumed content, such as read an article or watched a video.

Starred content — `starred_content`
: User starred or favorited content.

Shared content — `shared_content`
: User shared content.

The following table describes properties for content events:

| Property         | Type   |
|------------------|--------|
| `category`       | String |
| `id`             | String |
| `description`    | String |
| `type`           | String |
| `author`         | String |
| `feature`        | String |
| `published_date` | Date   |

### Search

Your project includes this predefined search event:

Search — `search`
: User performed a search.

The following table describes properties for the search event:

| Property        | Type   |
|-----------------|--------|
| `type`          | String |
| `query`         | String |
| `category`      | String |
| `id`            | String |
| `total_results` | Number |