API referenceWebhook events

message.sent

A message sent by the account: through Postgale, or elsewhere (Meta echo, e.g. from the Instagram app or, with WhatsApp coexistence, the WhatsApp Business app)

Header Parameters

X-SocialAPI-Signature*string
X-SocialAPI-Timestamp*string
X-SocialAPI-Event*string
X-SocialAPI-Delivery*string
X-Idempotency-Key*string

Request Body

application/json
  1. body
id*string

Idempotency key (= X-Idempotency-Key)

event*string
Value in"post.published""post.failed""post.pending_approval""post.approved""post.rejected""action.pending_approval""action.approved""action.rejected""action.executed""action.failed""comment.received""mention.received""message.received""message.sent""message.read""message.delivered""message.reaction""message.status""message.edited""message.deleted""message.failed""reaction.received""template.status""template.quality""account.quality""account.connected""account.disconnected""connection.pending""phone_number.provisioned""phone_number.release_scheduled""phone_number.released""phone_number.failed""webhook.test"
createdAt*string
Formatdate-time
data*

Response Body

Acknowledged; anything else is retried (6 attempts, exponential backoff)

Example Requests
POST/message.sent
Request Body
application/json
{  "id": "string",  "event": "post.published",  "createdAt": "2019-08-24T14:15:22Z",  "data": {}}
Header Parameters
{  "X-SocialAPI-Signature": "string",  "X-SocialAPI-Timestamp": "string",  "X-SocialAPI-Event": "string",  "X-SocialAPI-Delivery": "string",  "X-Idempotency-Key": "string"}

message.received Webhook

A direct message (or postback) from a person to an Instagram, Facebook Page, WhatsApp or Bluesky account (Bluesky: inbox poll). WhatsApp group messages belong to the group's conversation (participant id group:<groupId>; metadata.groupId and metadata.sender); Messenger standby messages (another app owns the thread) carry metadata.standby true

message.read Webhook

The person read the account's messages (up to watermark / platformMessageId)