Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version
string
required

Management API version.

Body

application/json
url
string
required

URL of the webhook endpoint. Must start with https://.

Example:

"https://website.com/webhook"

description
string

Description of the webhook.

Example:

"My Webhook"

status
enum<string>

Status of the webhook: 'enabled' or 'disabled'.

Available options:
enabled,
disabled
environment
object

Environment ID this webhook is associated with. Null if global.

Response

Webhook created, but needs to be verified before it's active.

data
object
required