Skip to main content
POST
Register an outgoing webhook

Authorizations

Authorization
string
header
required

An API token. The "read" ability: GET routes only. "read + write": every route.

Headers

Idempotency-Key
string

Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true).

Maximum string length: 255

Body

application/json
url
string<uri>
required
Maximum string length: 2000
events
enum<string>[]
required
Minimum array length: 1
Available options:
subscriber.created,
subscriber.confirmed,
subscriber.unsubscribed,
subscriber.tag_added,
subscriber.tag_removed,
campaign.sent,
mail.bounced,
mail.complaint
list_id
string<uuid> | null

Only what happens in this list.

name
string | null

What it is called in the settings. The host of the address, when absent.

Response

Webhook registered. secret is only ever shown here.

data
object