Skip to main content
POST
Create webhook endpoint

Authorizations

Authorization
string
header
required

Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...

Body

application/json

Endpoint config

events
enum<string>[]
required

Events is the list of event types to subscribe to.

Available options:
post.scheduled,
post.published,
post.failed,
post.partial,
post.updated,
post.deleted,
post.unpublished,
post.retried,
comment.received,
dm.received,
dm.sent,
dm.referral,
dm.postback,
dm.status.sent,
dm.status.delivered,
dm.status.read,
dm.status.failed,
review.received,
mention.received,
account.connected,
account.disconnected,
page.removed
Example:
url
string

URL is the HTTPS endpoint that will receive webhook POST requests.

Example:

"https://example.com/webhooks/socialapi"

Response

Endpoint created

events
string[]
Example:
id
string
Example:

"wh_01HZ9X3Q4R5M6N7P8V2K0W1J"

message
string
Example:

"Store the secret securely. It will not be shown again."

secret
string
Example:

"4f3c2a1b9e8d7c6f5e4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2"

url
string
Example:

"https://example.com/webhooks/socialapi"