Events reference

Activity names and property information for default, predefined, and custom events.

Events on this page are in the format:

Event name activity_name
Definition.

Definitions are provided for default and custom events only. Click Properties below an event to see a list of properties, use cases, and paths. Predefined events list properties and types.

Default events and properties

Below is a list of all available default events per channel. Default events need no additional configuration on your part.

App events

App open app_open

User opened mobile app.

Properties

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`

Message received message_received

User was sent a message by Airship.

Properties

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.

Properties

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.

Properties

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.

Properties

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`

In-app message display in_app_message_display

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

Properties

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.

Properties

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

First seen first_seen

An event that occurs when members of your audience opt in to notifications or open your app for the first time.

Properties

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`

Screen view screen_view

User viewed a particular screen in your app.

Properties

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.

Properties

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.

Properties

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.

Properties

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

Survey was displayed on a user’s device.

Properties

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

Survey was submitted by a user.

Properties

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

Survey was dismissed without being submitted.

Properties

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[*]`

Web events

First seen first_seen

An event that occurs when members of your audience opt in to notifications or open your app for the first time.

Properties

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.

Properties

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.

Properties

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 .

Properties

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`

Email events

First seen first_seen

An event that occurs when members of your audience opt in to notifications or open your app for the first time.

Properties

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.

Properties

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

Recipient clicked a tracked link in a message.

Properties

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

Properties

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.

Properties

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.

Properties

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

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

Properties

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

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

Properties

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.

Properties

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

First seen first_seen

An event that occurs when members of your audience opt in to notifications or open your app for the first time.

Properties

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.

Properties

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.

Properties

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.

Properties

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.

Properties

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.

Properties

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.

Properties

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.

Properties

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.

Properties

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.

Properties

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, sequences, scenes, and surveys. 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.

Note

Transaction ID is not currently supported with event segmentation for predefined events.

Purchased purchased

Properties

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

Registered for account registered_account

Properties

property	type
`category`	string

Browsed browsed

Properties

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

Added to cart added_to_cart

Properties

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

Starred product starred_product

Properties

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

Shared product shared_product

Properties

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

Added to wishlist add_to_wishlist

Properties

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

Properties

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

Starred content starred_content

Properties

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

Shared content shared_content

Properties

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

Browsed content browsed_content

Properties

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

Consumed content consumed_content

Properties

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

Search search

Properties

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

Logged in logged_in

Properties

property	type
`user_id`	string
`type`	string

Logged out logged_out

Properties

property	type
`user_id`	string
`type`	string

Feedback

Was this page helpful?