message_deliveries Webhook Event Reference

Breaking Change Notice

Effective February 19, 2018, this webhook event will no longer be triggered by message sends that use recipient.user_ref or recipient.phone_number to identify the message recipient.

This callback will occur when a message a Page has sent has been delivered. You can subscribe to this callback by selecting the message_deliveries field when setting up your webhook.

Example

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
   "delivery":{
      "mids":[
         "mid.1458668856218:ed81099e15d3f4f233"
      ],
      "watermark":1458668856253,
      "seq":37
   }
}    

Properties

sender

PropertyTypeDescription

id

String

The PSID of the user that triggered the webhook event.

recipient

PropertyTypeDescription

id

String

Your Page ID.

delivery

Property Type Description

mids

Array

Array containing message IDs of messages that were delivered. Field may not be present.

watermark

Number

All messages that were sent before this timestamp were delivered

seq

Number

Sequence number

Both mids and watermark fields are used to determine which messages were delivered. watermark is always present and mids is sometimes present. mids provides delivery receipts on a per-message basis but may not be present (due to backward compatibility reasons with older Messenger clients). watermark is always present and is a timestamp indicating that all messages with a timestamp before watermark were delivered.