API referenceWebhook events

comment.received

A new comment or reply on an Instagram, Facebook or Threads account (inbound Meta webhook)

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""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/comment.received
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"}

action.failed Webhook

An approved action failed when it ran (action.error: message and code, e.g. outside_messaging_window, credential_revoked)

mention.received Webhook

The account was mentioned (Threads, Facebook mention field, Instagram mentions field where offered; with Instagram Login @mentions in comments arrive as comment.received)