Events reference

Events on this page are in the format:

Event name activity_name

Definition.

Definitions are provided for default and custom events only. Following definitions are tables of properties, use cases, and paths. Tables for predefined events list properties and types.

See also:

• Events user guide
• API: Activity Audience Object

For a complete list of events, see our RTDS API Reference.

Default events and properties

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

App events

These events are recorded for mobile apps.

First seen first_seen

User opted in to notifications or opened your app for the first time.

Property	Use Case	Path
Platform	Target users who were first seenA trigger that initiates an Automation or Sequence when members of your audience opt in to notifications or open your app for the first time. on a specific platform in a sequence.	/_msg/platform

App open app_open

User opened your mobile app.

Property	Use Case	Path
Push ID	Opened app as result of a specific Push IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Opened app as result of a specific Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_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

In-app message display in_app_message_display

In-app message was displayed on user’s device.

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

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 received message_received

User was sent a message by Airship.

Property	Use Case	Path
Push ID	Received a message associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_msg/group_id
Variant ID	Received message as a member 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 read message_center_read

User viewed Message Center message.

Property	Use Case	Path
Push ID	Received a message associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_msg/group_id
Variant ID	Received message as a member 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 delivered message_center_delivered

Message Center message was delivered to device.

Property	Use Case	Path
Push ID	Received a message associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_msg/group_id
Variant ID	Received message as a member 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 deleted message_center_deleted

Message Center message was deleted by user.

Property	Use Case	Path
Push ID	Received a message associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_msg/group_id
Variant ID	Received message as a member 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 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.

Property	Use Case	Path
Push ID	Did not receive a message associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Group ID	Did not receive a message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_msg/group_id
Variant ID	Did not receive a message as a member 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

These events are recorded for websites.

First seen first_seen

User opted in to notifications or opened your app for the first time.

Property	Use Case	Path
Platform	Target users who were first seenA trigger that initiates an Automation or Sequence when members of your audience opt in to notifications or open your app for the first time. on a specific platform in a sequence.	/_msg/platform

Message received message_received

User was sent a message by Airship.

Property	Use Case	Path
Push ID	Received a message associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_msg/group_id
Variant ID	Received message as a member a specific A/B test variant.	/_msg/variant_id
Campaign Category	Received message from a push with a specific campaign category.	$._msg.campaigns.categories[*]

Web click web_click

User clicked the web notification.

Property	Use Case	Path
Push ID	Received a message associated with a Push IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id

Web session web_session

User generated a web sessionA session that occurs when an end user directly visits a website with the Airship Web SDK present or by clicking or tapping a Web Push Notification that leads the visitor to the website. The page the user visits must have the Web SDK installed to track sessions. A new session is generated after 30 minutes of inactivity..

Property	Use Case	Path
Push ID	Received a message associated with a Push IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id

App and Web events

These events are recorded for both mobile apps and web.

Screen view screen_view

User viewed a particular screen in your app or website. See: App Screens.

Property	Use Case	Path
Viewed screen	User viewed a specific screen in your app, e.g., “Contact us”.	viewed_screen

Scene displayed scene_displayed

User viewed at least the first screen in a Scene.

Property	Use Case	Path
Push ID	Received a scene associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Campaign Category	Received a scene from a push with a specific campaign category.	$._msg.campaigns.categories[*]

Scene completed scene_completed

User viewed all the screens in a Scene.

Property	Use Case	Path
Push ID	Received a scene associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Campaign Category	Received a scene from a push with a specific campaign category.	$._msg.campaigns.categories[*]

Scene incomplete scene_incomplete

User dismissed a Scene before the last screen was viewed.

Property	Use Case	Path
Push ID	Received a scene associated with a Push IDA unique identifier for a push operation..	/_msg/push_id
Campaign Category	Received a scene from a push with a specific campaign category.	$._msg.campaigns.categories[*]

Survey displayed survey_displayed

Scene containing questions or NPS survey was displayed on a user’s device.

Property	Use Case	Path
Push ID	Received a survey associated with a Push IDA unique identifier for a push operation..	/_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[*]

Survey submitted survey_submitted

Scene containing questions or NPS survey was submitted by a user.

Property	Use Case	Path
Push ID	Received a survey associated with a Push IDA unique identifier for a push operation..	/_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[*]

Survey not submitted survey_not_submitted

Scene containing questions or NPS survey was dismissed without being submitted.

Property	Use Case	Path
Push ID	Received a survey associated with a Push IDA unique identifier for a push operation..	/_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[*]

Email events

These events are recorded for email.

First seen first_seen

User opted in to notifications or opened your app for the first time.

Property	Use Case	Path
Platform	Target users who were first seenA trigger that initiates an Automation or Sequence when members of your audience opt in to notifications or open your app for the first time. on a specific platform in a sequence.	/_msg/platform

Email bounce email_bounce

Email could not be delivered to an address.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id
Campaign Category	Received message associated with a specific campaign category.	$._triggering_push.campaigns.categories[*]

Email click email_click

User clicked a tracked link in a message. Only HTTP and HTTPS links are tracked.

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.	link_name
Email address	Message targeted recipient’s email address.	email
Push ID	Received a message associated with a Push IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id
Campaign Category	Received message associated with a specific campaign category.	$._triggering_push.campaigns.categories[*]

Email delay email_delay

Mailbox provider temporarily rejected an email. In general, this event indicates that the provider will attempt to resend the message.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id
Campaign Category	Received message associated with a specific campaign category.	$._triggering_push.campaigns.categories[*]

Email delivered email_delivered

Remote email server acknowledged receipt of a message.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id
Campaign Category	Received message associated with a specific campaign category.	$._triggering_push.campaigns.categories[*]

Email injection email_injection

The number of emails successfully sent from Sparkpost to the email provider.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id
Campaign Category	Received message associated with a specific campaign category.	$._triggering_push.campaigns.categories[*]

Initial open initial_open

User opened an email, rendering a tracking pixel at the top of the message.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id
Campaign Category	Received message associated with a specific campaign category.	$._triggering_push.campaigns.categories[*]

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.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id
Campaign Category	Received message associated with a specific campaign category.	$._triggering_push.campaigns.categories[*]

Email unsubscribe email_unsubscribe

User clicked an unsubscribe link in an email you sent.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id
Campaign Category	Received message associated with a specific campaign category.	$._triggering_push.campaigns.categories[*]

SMS events

These events are recorded for SMS.

First seen first_seen

User opted in to notifications or opened your app for the first time.

Property	Use Case	Path
Platform	Target users who were first seenA trigger that initiates an Automation or Sequence when members of your audience opt in to notifications or open your app for the first time. on a specific platform in a sequence.	/_msg/platform

SMS aborted sms_aborted

SMS message was aborted before reaching short message service center.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id

SMS delivered sms_delivered

SMS message was delivered.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id

SMS dispatched sms_dispatched

SMS message was dispatched and accepted for delivery by the short message service center.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id

SMS expired sms_expired

SMS message expired before delivery to the short message service center.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id

SMS failed sms_failed

SMS message failed to be delivered.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id

SMS rejected sms_rejected

SMS message was rejected by short message service center.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id

SMS undeliverable sms_undeliverable

SMS message could not be delivered.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id

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.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id

Short Link click short_link_click

User clicked the Short Link in the sent message.

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 IDA unique identifier for a push operation..	/_triggering_push/push_id
Group ID	Received message associated with a Group IDA unique identifier for a group of notifications delivered over an interval of time, e.g., multiple push IDs related to an ongoing Automation, Sequence, or a push-to-local-time send..	/_triggering_push/group_id

Predefined events and properties

Below is a list of all available predefined events. See Custom Event Templates for SDK implementation details.

Before you can segment on predefined events you must activate them for segmentation in the dashboard. Predefined events are Custom EventsEvents that indicate that a user performed a predefined action, such as adding an item to a shopping cart, viewing a screen, or clicking an Unsubscribe button. Custom Events can trigger automation, including Sequences and Scenes. You can code them into your app or website, or send them to Airship from an external source using the Custom Event API. Custom Events contain properties that you can use to personalize messages., so you can define additional properties for them if you like, as long as you declare the properties in the SDK.

Purchased purchased

property	type
category	string
id	string
description	string
brand	string
new_item	boolean

Registered for account registered_account

property	type
category	string

Browsed browsed

property	type
category	string
id	string
description	string
brand	string
new_item	boolean

Added to cart added_to_cart

Property	Type
category	string
id	string
description	string
brand	string
new_item	boolean

Starred product starred_product

property	type
category	string
id	string
description	string
brand	string
new_item	boolean

Shared product shared_product

property	type
category	string
id	string
description	string
brand	string
new_item	boolean

Added to wishlist add_to_wishlist

Property	Type
wishlist_id	string
wishlist_name	string
category	string
id	string
description	string
brand	string
new_item	boolean

Removed from wishlist remove_from_wishlist

property	type
wishlist_id	string
wishlist_name	string
category	string
id	string
description	string
brand	string
new_item	boolean

Starred content starred_content

property	type
category	string
id	string
description	string
type	string
author	string
feature	string
published_date	date

Shared content shared_content

property	type
category	string
id	string
description	string
type	string
author	string
feature	string
published_date	date

Browsed content browsed_content

property	type
category	string
id	string
description	string
type	string
author	string
feature	string
published_date	date

Consumed content consumed_content

property	type
category	string
id	string
description	string
type	string
author	string
feature	string
published_date	date

Search search

property	type
type	string
query	string
category	string
id	string
total_results	number

Logged in logged_in

property	type
user_id	string
type	string

Logged out logged_out

property	type
user_id	string
type	string