For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Getting started
    • Overview
    • Quickstart
    • Authentication
    • Rate limits
  • Messaging API
    • Send transactional email
    • Send transactional SMS
    • Send transactional WhatsApp
  • Marketing Platform
    • Manage your contacts
    • Track website activity
    • Send WhatsApp campaigns
    • Weekly event exports
  • Webhooks
    • Getting started
    • Conversations webhooks
    • Payment webhooks
    • Marketing webhooks
    • Transactional webhooks
    • Loyalty webhooks
    • Batched webhooks
    • Secure webhook calls
    • Meetings and phone webhooks
    • Push notification webhooks
    • Sales CRM webhooks
  • Conversations
    • Getting started
    • Customize the chat widget
    • JavaScript API reference
    • REST API reference
    • Conversations webhooks
  • eCommerce
    • Activate eCommerce app
    • Manage product categories
    • Manage products
    • Manage orders
    • Coupon collections
    • eCommerce tracker events
  • Loyalty
    • Overview
    • Set up a program
    • Enroll members
    • Credit & debit points
    • Read member data
    • Best practices
  • Custom Objects
    • Custom objects management
  • Brevo tracker and events
    • Getting started
    • JavaScript implementation
    • REST implementation
    • Legacy tracker documentation
    • Events
  • Accounts and settings
    • Senders and domains
    • User activity logs
    • External feeds
    • Invited users
LogoLogo
Help CenterAPI KeysStatusSign In
On this page
  • Push notification clicked
  • Push subscribed
  • Push unsubscribed
  • Push session started
Webhooks

Push notification webhooks

Was this page helpful?
Previous

Sales CRM webhooks

Next
Built with

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

  • Push notification clicked
  • Push subscribed
  • Push unsubscribed
  • Push session started

Push notification clicked

Attribute nameDatatypeDescription
reporting.attributionReasonStringReason for notification click
reporting.campaignIdStringCampaign ID of campaign that triggered push notification
reporting.notificationIdStringNotification ID of push notification
1{
2  "reporting": {
3    "attributionReason": "notificationOpened",
4    "campaignId": "000jdxx0063",
5    "notificationId": "01xx7yxxx5rfgh"
6  }
7}

Push subscribed

Attribute nameDatatypeDescription
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
1{"subtype":"new"}

Push unsubscribed

Attribute nameDatatypeDescription
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
1{"subtype":"new"}

Push session started

Attribute nameDatatypeDescription
reporting.attributionReasonStringReason for session start
reporting.campaignIdStringCampaign ID of campaign that triggered the push
reporting.notificationIdStringNotification ID of push notification sent
1{
2  "reporting": {
3    "attributionReason": "notificationOpened",
4    "campaignId": "000jdxx0063",
5    "notificationId": "01xx7yxxx5rfgh"
6  }
7}