Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Body

application/json
url
string<uri>
required

https URL that answers 2xx within 10 seconds. Private and local addresses are refused.

description
string
Maximum string length: 200
events
enum<string>[]

Omit or send [] for every event.

Available options:
email.sent,
email.delivered,
email.bounced,
email.complained,
email.failed,
email.unsubscribed,
sms.sent,
sms.delivered,
sms.failed,
sms.opted_out,
usage.threshold,
credits.low,
billing.payment_failed

Response

Created, with the signing secret

id
string
required
Example:

"whk_01j9x7k2r4m8q3v5n6b7c8d9e0"

url
string
required
description
string | null
required
events
string[]
required

Empty means every event.

enabled
boolean
required
disabledReason
string | null
required
secretPrefix
string
required
Example:

"whsec_a1b2c3"

failingSince
string<date-time> | null
required
lastSuccessAt
string<date-time> | null
required
lastFailureAt
string<date-time> | null
required
createdAt
string<date-time>
required
secret
string
required

Shown once. Verify signatures with it.