Skip to main content
POST
Create webhook endpoint

Authorizations

X-App-Id
string
header
required

App ID for authentication

X-Api-Key
string
header
required

API Key for authentication

Body

application/json
url
string
required

HTTPS, on a public host.

events
string[]
required

Event types to receive, or ["*"] for everything we send, including types added later.

description
string | null

Response

Created. Includes the signing secret.

uuid
string
url
string
description
string | null
events
string[]
status
enum<string>
Available options:
enabled,
disabled
disabled_reason
string | null

Why the endpoint switched itself off. Null while enabled.

last_success_at
string<date-time> | null
last_failure_at
string<date-time> | null
created_at
string<date-time>
secret
string

Signs every delivery. Returned only on create and rotate.

Example:

"whsec_Hk3m9QpXa7Tz2Lr8Vn4Bc6Wd1Ys5Fe0Gj"