Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Body

application/json
name
string
required
Minimum string length: 1
Example:

"Email Events Webhook"

url
string<uri>
required
Example:

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

type
enum<string>
required

Webhook category type that determines which events the webhook subscribes to

Available options:
transactional,
domain,
receiving
Example:

"transactional"

inbox_ids
string<uuid>[]

Optional array of inbox UUIDs to scope receiving webhooks. Only applicable when type is 'receiving'.

Example:

Response

Webhook created

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>
required
name
string
required
url
string<uri>
required
type
enum<string>
required

Webhook category type that determines which events the webhook subscribes to

Available options:
transactional,
domain,
receiving
Example:

"transactional"

events
string[]
required

Derived list of events based on the webhook type. Read-only.

inbox_ids
string<uuid>[] | null
required

Inbox UUIDs for scoping receiving webhooks. Null for non-receiving types.

secret
string
required
active
boolean
required
created_by
string<uuid> | null
required
created_at
string<date-time>
required