Push notification webhooks

View as Markdown

This page lists the currently supported Push notification webhook events and their payloads.

Push notification clicked

Attribute nameData typeDescription
reporting.attributionReasonStringReason for notification click
reporting.campaignIdStringCampaign ID of campaign that triggered push notification
reporting.notificationIdStringNotification ID of push notification
{
"reporting": {
"attributionReason": "notificationOpened",
"campaignId": "000jdxx0063",
"notificationId": "01xx7yxxx5rfgh"
}
}

Push subscribed

Attribute nameData typeDescription
subtypeStringOne of: new, moved, soft, inactivity
New: user subscribes
Moved: push token moved to that installation because user logged in
Soft: User decides to show notifications
Inactivity: Resubscribed at the end of a period of inactivity
{"subtype":"new"}

Push unsubscribed

Attribute nameData typeDescription
subtypeStringOne of: new, moved, soft, inactivity
New: user subscribes
Moved: push token moved to that installation because user logged in
Soft: User decides to show notifications
Inactivity: Resubscribed at the end of a period of inactivity
{"subtype":"new"}

Push session started

Attribute nameData typeDescription
reporting.attributionReasonStringReason for session start
reporting.campaignIdStringCampaign ID of campaign that triggered the push
reporting.notificationIdStringNotification ID of push notification sent
{
"reporting": {
"attributionReason": "notificationOpened",
"campaignId": "000jdxx0063",
"notificationId": "01xx7yxxx5rfgh"
}
}