message_reads 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 read by the user.
You can subscribe to this callback by selecting the message_reads field when setting up your webhook.

Example

{
   "sender":{
      "id":"<PSID>"
   },
   "recipient":{
      "id":"<PAGE_ID>"
   },
   "timestamp":1458668856463,
   "read":{
      "watermark":1458668856253,
      "seq":38
   }
}    

Properties

sender

PropertyTypeDescription

id

String

The PSID of the user that triggered the webhook event.

recipient

PropertyTypeDescription

id

String

Your Page ID.

read

Property Type Description

watermark

Number

All messages that were sent before this timestamp were read

seq

Number

Sequence number

The watermark field is used to determine which messages were read. It represents a timestamp indicating that all messages with a timestamp before watermark were read by the recipient.