Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

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

Body

application/json
url
string
required

HTTPS URL that receives webhook deliveries; IP addresses are rejected.

Example:

"https://example.com/webhook"

description
string

Human-readable purpose of the webhook.

Response

Created

created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was created.

description
string | null
required

Webhook purpose.

id
string
required

Unique resource identifier.

is_active
boolean
required

Whether the webhook is active.

modified_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was last modified.

secret
string
required

Signing secret returned when the webhook is created.

url
string
required

Webhook destination URL.