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. Following definitions are tables of properties, use cases, and paths. Tables for predefined events list properties and types.

See also:

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.

PropertyUse CasePath
PlatformTarget 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.

PropertyUse CasePath
Push IDOpened app as result of a specific Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDOpened 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 IDOpened app as result of a specific A/B test variant./_triggering_push/variant_id
Campaign CategoryOpened 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.

PropertyUse CasePath
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Group IDReceived 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 IDReceived message as a member a specific A/B test variant./_msg/variant_id
Campaign CategoryReceived message from a push with a specific campaign category.$._msg.campaigns.categories[*]

Message Center read message_center_read

User viewed Message Center message.

PropertyUse CasePath
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Group IDReceived 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 IDReceived message as a member a specific A/B test variant./_msg/variant_id
Campaign CategoryReceived 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.

PropertyUse CasePath
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Group IDReceived 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 IDReceived message as a member a specific A/B test variant./_msg/variant_id
Campaign CategoryReceived 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.

PropertyUse CasePath
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Group IDReceived 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 IDReceived message as a member a specific A/B test variant./_msg/variant_id
Campaign CategoryReceived 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.

PropertyUse CasePath
Push IDDid not receive a message associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Group IDDid 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 IDDid not receive a message as a member a specific A/B test variant./_msg/variant_id
Campaign CategoryDid not receive a message from a push with a specific campaign category./_msg/campaigns/categories

Screen view screen_view

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

PropertyUse CasePath
Viewed screenUser 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.

PropertyUse CasePath
Push IDReceived a scene associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Campaign CategoryReceived 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.

PropertyUse CasePath
Push IDReceived a scene associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Campaign CategoryReceived 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.

PropertyUse CasePath
Push IDReceived a scene associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Campaign CategoryReceived 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.

PropertyUse CasePath
Push IDReceived a survey associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Survey typeReceived a survey associated with a survey type nps or user_feedback./_msg/context/state/form/response_type
Campaign CategoryReceived survey from a push with a specific campaign category.$._msg.campaigns.categories[*]

Survey submitted survey_submitted

Survey was submitted by a user.

PropertyUse CasePath
Push IDReceived a survey associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Survey typeReceived a survey associated with a survey type nps or user_feedback./_msg/context/state/form/response_type
Campaign CategoryReceived survey from a push with a specific campaign category.$._msg.campaigns.categories[*]

Survey not submitted survey_not_submitted

Survey was dismissed without being submitted.

PropertyUse CasePath
Push IDReceived a survey associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Survey typeReceived a survey associated with a survey type nps or user_feedback./_msg/context/state/form/response_type
Campaign CategoryReceived survey 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.

PropertyUse CasePath
PlatformTarget 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.

PropertyUse CasePath
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_msg/push_id
Group IDReceived 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 IDReceived message as a member a specific A/B test variant./_msg/variant_id
Campaign CategoryReceived message from a push with a specific campaign category.$._msg.campaigns.categories[*]

Web click web_click

User clicked the web notification.

PropertyUse CasePath
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 opted-in user directly visits a website with the Airship Web SDK present, or by clicking a web notification that leads the visitor to the site. The page the user visits must have the Web SDK installed to track sessions. A new session is generated after 30 minutes of inactivity. .

PropertyUse CasePath
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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

These events are recorded for email.

First seen first_seen

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

PropertyUse CasePath
PlatformTarget 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.

PropertyUse CasePath
SenderReceived email from a specific email address.sender
SubjectReceived email with specific subject.subject
Email addressMessage targeted recipient’s email address.email
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 CategoryReceived 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.

PropertyUse CasePath
SenderReceived email from a specific email address.sender
SubjectReceived email with specific subject.subject
Link URLUser clicked on a specific email link.link_url
Email addressMessage targeted recipient’s email address.email
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 CategoryReceived 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.

PropertyUse CasePath
SenderReceived email from a specific email address.sender
SubjectReceived email with specific subject.subject
Email addressMessage targeted recipient’s email address.email
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 CategoryReceived message associated with a specific campaign category.$._triggering_push.campaigns.categories[*]

Email delivered email_delivered

Remote email server acknowledged receipt of a message.

PropertyUse CasePath
SenderReceived email from a specific email address.sender
SubjectReceived email with specific subject.subject
Email addressMessage targeted recipient’s email address.email
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 CategoryReceived 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.

PropertyUse CasePath
SenderReceived email from a specific email address.sender
SubjectReceived email with specific subject.subject
Email addressMessage targeted recipient’s email address.email
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 CategoryReceived 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.

PropertyUse CasePath
SenderReceived email from a specific email address.sender
SubjectReceived email with specific subject.subject
Email addressMessage targeted recipient’s email address.email
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 CategoryReceived 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.

PropertyUse CasePath
SenderReceived email from a specific email address.sender
SubjectReceived email with specific subject.subject
Email addressMessage targeted recipient’s email address.email
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 CategoryReceived 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.

PropertyUse CasePath
UnsubscribeUser unsubscribes via the link that you provided. Note: there is only one unsubscribe event type (link_unsubscribe)unsubscribe_event_type
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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 CategoryReceived 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.

PropertyUse CasePath
PlatformTarget 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.

PropertyUse CasePath
Vendor Delivery IDReceived SMS from specific vendor.vendorDeliveryId
Sender IDReceived SMS from specific sender.sender
Error codeSMS resulted in specific error code.error_code
Push IDReceived 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.

PropertyUse CasePath
Vendor Delivery IDReceived SMS from specific vendor.vendorDeliveryId
Sender IDReceived SMS from specific sender.sender
Error codeSMS resulted in specific error code.error_code
Push IDReceived 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.

PropertyUse CasePath
Vendor Delivery IDReceived SMS from specific vendor.vendorDeliveryId
Sender IDReceived SMS from specific sender.sender
Error codeSMS resulted in specific error code.error_code
Push IDReceived 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.

PropertyUse CasePath
Vendor Delivery IDReceived SMS from specific vendor.vendorDeliveryId
Sender IDReceived SMS from specific sender.sender
Error codeSMS resulted in specific error code.error_code
Push IDReceived 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.

PropertyUse CasePath
Vendor Delivery IDReceived SMS from specific vendor.vendorDeliveryId
Sender IDReceived SMS from specific sender.sender
Error codeSMS resulted in specific error code.error_code
Push IDReceived 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.

PropertyUse CasePath
Vendor Delivery IDReceived SMS from specific vendor.vendorDeliveryId
Sender IDReceived SMS from specific sender.sender
Error codeSMS resulted in specific error code.error_code
Push IDReceived 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.

PropertyUse CasePath
Vendor Delivery IDReceived SMS from specific vendor.vendorDeliveryId
Sender IDReceived SMS from specific sender.sender
Error codeSMS resulted in specific error code.error_code
Push IDReceived 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.

PropertyUse CasePath
Vendor Delivery IDReceived SMS from specific vendor.vendorDeliveryId
Sender IDReceived SMS from specific sender.sender
Error codeSMS resulted in specific error code.error_code
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id

User clicked the Short Link in the sent message.

PropertyUse CasePath
Original UrlUser clicked on a shortened link in a messageoriginal_url
Push IDReceived a message associated with a Push IDA unique identifier for a push operation. ./_triggering_push/push_id
Group IDReceived 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, 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

propertytype
categorystring
idstring
descriptionstring
brandstring
new_itemboolean

Registered for account registered_account

propertytype
categorystring

Browsed browsed

propertytype
categorystring
idstring
descriptionstring
brandstring
new_itemboolean

Added to cart added_to_cart

PropertyType
categorystring
idstring
descriptionstring
brandstring
new_itemboolean

Starred product starred_product

propertytype
categorystring
idstring
descriptionstring
brandstring
new_itemboolean

Shared product shared_product

propertytype
categorystring
idstring
descriptionstring
brandstring
new_itemboolean

Added to wishlist add_to_wishlist

PropertyType
wishlist_idstring
wishlist_namestring
categorystring
idstring
descriptionstring
brandstring
new_itemboolean

Removed from wishlist remove_from_wishlist

propertytype
wishlist_idstring
wishlist_namestring
categorystring
idstring
descriptionstring
brandstring
new_itemboolean

Starred content starred_content

propertytype
categorystring
idstring
descriptionstring
typestring
authorstring
featurestring
published_datedate

Shared content shared_content

propertytype
categorystring
idstring
descriptionstring
typestring
authorstring
featurestring
published_datedate

Browsed content browsed_content

propertytype
categorystring
idstring
descriptionstring
typestring
authorstring
featurestring
published_datedate

Consumed content consumed_content

propertytype
categorystring
idstring
descriptionstring
typestring
authorstring
featurestring
published_datedate
propertytype
typestring
querystring
categorystring
idstring
total_resultsnumber

Logged in logged_in

propertytype
user_idstring
typestring

Logged out logged_out

propertytype
user_idstring
typestring