messaging_postbacks Webhook Event Reference
A postback webhook event is triggered when a users clicks a postback button, Get Started button, or persistent menu item.
Example Payload
{
"sender":{
"user_ref":"USER-REF-ID"
},
"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": "SHORT-URL",
"type": "OPEN_THREAD",
}
}
} Properties
sender
| Property | Type | Description |
|---|---|---|
| String | The PSID of the user that triggered the webhook event. |
| 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 |
|---|---|---|
| String | Your Page ID. |
postback
| Property | Type | Description |
|---|---|---|
| String | Message ID |
| 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. |
| String |
|
| 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.