GuidesAPI ReferenceChangelogDiscussions
Log In

📘

Note

All events include Session Properties, Device Properties, App Properties, and Shopify Properties that are present on the Event Object. For more information, refer to the Common Event Object & Metadata document.

Event Properties, however, are unique to every event and are outlined in this page.

The Push Notification Received event fires when a user receives a push notification. This can occur when the app is in the background and a push notification is tapped on, or when the app is in the foreground and a push is received.

The event properties unique to this event include:

  "event_properties": {
    "event_id": "3aabcb99-48ee-4713-8d83-93a55db4c697",
    "notification_id": "qab0QpEpGC",
    "notification_title": "Buy it now!",
    "notification_message": "10% off now",
    "notification_image": null,
    "target": null,
    "notification_type": "dashboard"
  },
  "

event_id String : The unique identifier of the session associated with the event. This event will also exist on the Event object level as well


target String : The specific push notification automation associated with the notification received


notification_id String : The unique ID of the push notification that was received


notification_title String : The title of the push notification that was received


notification_message String : The message of the push notification that was received


notification_image String : The image associated with the push notification that was received


notification_type String : Whether the push notification came from the Merchant Dashboard or an integration

Note: To view all of the various notification types, reference the Event Sources page