Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Organization key (alk_…) created under Settings; acts for the whole organization

Body

application/json
url
string
required

HTTPS URL of your receiver

Required string length: 8 - 2048
description
string
Maximum string length: 200
event_types
enum<string>[]

Only these event types; omitted means all

Maximum array length: 20
Available options:
message.received,
message.quarantined,
message.sent,
message.delivered,
message.delivery_delayed,
message.bounced,
message.complained,
message.failed,
message.approval_requested,
message.approved,
message.rejected,
thread.updated,
inbox.created,
inbox.deleted,
domain.verified,
sms.received,
sms.quarantined,
sms.sent,
sms.delivered,
sms.failed,
social.account_connected,
social.account_disconnected,
social.post_published,
social.post_failed,
social.message_received,
social.comment_received
inbox_id
string

Only events of this inbox; omitted means every inbox

Minimum string length: 1

Response

Endpoint and secret

webhook
object
required
secret
string
required

Signing secret, shown once