Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

API key from Developer dashboard (Bearer token).

Body

application/json
url
string<uri>
required

Public HTTPS endpoint that receives signed POSTs.

events
enum<string>[]
required

Events to subscribe to. Must be from the 25-event catalog (see the webhooks object in this spec and the Webhooks guide).

Available options:
post.published,
post.partial,
post.failed,
account.connected,
account.disconnected,
account.token_expired,
comment.received,
message.received,
job.completed,
job.failed,
balance.low,
balance.depleted,
key.revoked,
wallet.recharge.succeeded,
wallet.recharge.failed,
account_billing.charged,
account_billing.failed,
contact.created,
contact.updated,
contact.tag_added,
contact.tag_removed,
deal.created,
deal.stage_changed,
deal.won,
deal.lost,
post.scheduled,
post.cancelled,
post.recycled,
post.external.created,
post.external.updated,
message.sent,
conversation.started,
reaction.received,
review.new,
review.updated,
message.delivered,
message.read,
message.failed

Response

Created

success
enum<boolean>
Available options:
true
data
object
meta
object