messaging_optins Webhook Event Reference

This callback will occur when the send to Messenger plugin has been tapped, a user has accepted a message request using customer matching, or a user has opted in to receive messages via the checkbox plugin.

When using the plugin, the optin.ref parameter is set by the data-ref field on the "Send to Messenger" plugin. This field can be used by the developer to associate a click event on the plugin with a callback.

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

Example

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1234567890,
  "optin": {
    "ref": "<PASS_THROUGH_PARAM>",
    "user_ref": "<REF_FROM_CHECKBOX_PLUGIN>"
  }
}    

messaging_optin events triggered when the user accepts a message request received from customer matching via the Send API, the following property will also be included in the optin object:

"message_request": "accept"

Properties

sender

recipient

optin