`messaging_postbacks` Webhook Event Reference

Postbacks occur when a postback button, Get Started button, or persistent menu item is tapped.

The payload field passed is defined in the above places.

You can subscribe to this callback by selecting the messaging_postbacks field when setting up your webhook.

Example

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "postback":{
    "mid":"m_1457764197618:41d102a3e1ae206a38",
    "title": "<TITLE_FOR_THE_CTA>",  
    "payload": "<USER_DEFINED_PAYLOAD>",
    "referral": {
      "ref": "<USER_DEFINED_REFERRAL_PARAM>",
      "source": "<SHORTLINK>",
      "type": "OPEN_THREAD",
    }
  }
}

Properties

Breaking Change (May 5, 2020)

Graph API v7.0+ messaging_postback webhook event from the chat plugin will not be returning sender.id field. It will return a new sender.user_ref field. This changes will take effect on all older Graph API versions starting Nov 2, 2020.

`sender`

Property	Type	Description
`id`	String	The PSID of the user that triggered the webhook event.
`user_ref`	String	The user_ref of the user that triggered the webhook event. This is only available for webhook event from the chat plugin.

`recipient`

Property	Type	Description
`id`	String	Your Page ID.

`postback`

June 8th, 2021 Announcement

The mid field was added in Graph API v11.0+

Property	Type	Description
`mid`	String	Message ID
`title`	String	Title for the CTA that was clicked on. This is sent to all apps subscribed to the page. For apps other than the original CTA sender, the postback event will be delivered via the standby channel.
`payload`	String	`payload` parameter that was defined with the button. This is only visible to the app that send the original template message.
`referral`	Structure follows referral event	Referral information for how the user got into the thread.

`postback.referral`

This section is present only if:

The user entered the thread via an m.me link with a ref parameter and tapped the Get Started button.
The user entered the thread by scanning a parametric Messenger Code and tapped the Get Started button.
This is the first postback after user came from a Messenger Conversation Ad.
The user entered the thread via Discover tab and tapped the Get Started button. See here for more info.

The information contained in this section follows that of the referral webhook.

messaging_postbacks Webhook Event Reference

Example

Properties

Breaking Change (May 5, 2020)

sender

recipient