Push notification webhooks | Brevo API Documentation

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

Push notification clicked

Attribute name	Datatype	Description
`reporting.attributionReason`	String	Reason for notification click
`reporting.campaignId`	String	Campaign ID of campaign that triggered push notification
`reporting.notificationId`	String	Notification ID of push notification

1 {
2   "reporting": {
3     "attributionReason": "notificationOpened",
4     "campaignId": "000jdxx0063",
5     "notificationId": "01xx7yxxx5rfgh"
6   }
7 }

Push subscribed

Attribute name	Datatype	Description
`subtype`	String	One 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

1 {"subtype":"new"}

Push unsubscribed

Attribute name	Datatype	Description
`subtype`	String	One 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

1 {"subtype":"new"}

Push session started

Attribute name	Datatype	Description
`reporting.attributionReason`	String	Reason for session start
`reporting.campaignId`	String	Campaign ID of campaign that triggered the push
`reporting.notificationId`	String	Notification ID of push notification sent

1 {
2   "reporting": {
3     "attributionReason": "notificationOpened",
4     "campaignId": "000jdxx0063",
5     "notificationId": "01xx7yxxx5rfgh"
6   }
7 }