Webhook Events Reference

Webhook events are how the Messenger Platform notifies your bot when a variety of interactions or events happen, including when a person sends a message. Webhook events are sent by the Messenger Platform as POST requests to your webhook.

Contents

List of Webhook Events

Below is a list of the events that can be sent to your webhook from the Messenger Platform.

Webhook Event Description

messages

Subscribes to Message Received events

messaging_account_linking

Subscribes to Account Linking events

messaging_checkout_updates (beta)

Subscribes to Checkout Update events

message_deliveries

Subscribes to Message Delivered events

message_echoes

Subscribes to Message Echo events

messaging_handovers (beta)

Subscribes to Handover Protocol events

messaging_optins

Subscribes to Plugin Opt-in events

messaging_payments (beta)

Subscribes to Payment events

messaging_policy_enforcement

Subscribes to Policy Enforcement events

messaging_postbacks

Subscribes to Postback Received events

messaging_pre_checkouts (beta)

Subscribes to Payment Pre-checkout events

message_reads

Subscribes to Message Read events

messaging_referrals

Subscribes to Referral events

standby (beta)

Subscribes to Handover Protocol Standby Channel events

Event Format

All callbacks for the Messenger Platform have a common set of properties that provide information you will need to process and respond to input from people using your bot. In addition to the properties below, each event also has a set of specific properties that detail the event.

{
  "object":"page",
  "entry":[
    {
      "id":"<PAGE_ID>",
      "time":1458692752478,
      "messaging":[
        {
          "sender":{
            "id":"<PSID>"
          },
          "recipient":{
            "id":"<PAGE_ID>"
          },

          ...
        }
      ]
    }
  ]
}

Properties

Property Type Description

object

String

Value will be page

entry

Array of entry

Array containing event data

entry

Property Type Description

id

String

Page ID of page

time

Number

Time of update (epoch time in milliseconds)

messaging

Array<messaging>

Array containing one messaging object. Note that even though this is an array, it will only contain one messaging object.

entry.messaging

Property Type Description

sender.id

String

Sender user ID

recipient.id

String

Recipient user ID