Skip to main content
Create a webhook (production)

Authorizations

X-API-Key
string
header
required

Body

application/json
events
string[]
required

Event types to receive.

Maximum array length: 20
url
string
required

An https:// URL on the public internet.

Maximum string length: 2048
description
string | null
Maximum string length: 255

Response

Successful Response

active
boolean
required
environment
string
required

test or production: the events it receives.

events
string[]
required
id
string
required
secret
string
required

The signing secret (whsec_...). Shown only in this response: store it now.

secret_last4
string
required

The last 4 characters of the signing secret.

url
string
required
created_at
string | null
description
string | null
updated_at
string | null