Skip to main content
POST
Create Webhook

Authorizations

Authorization
string
header
required

Bearer authentication with an API token

Body

application/json
url
string
required

The URL to send webhook events to

label
string
required

A friendly label to associate with the webhook registration

Response

Success

id
string
read-only

The unique identifier of the webhook

url
string
read-only

The URL to send webhook events to

label
string
read-only

A friendly label to associate with the webhook registration

created_at
string
read-only

The date and time the webhook was created

status
string
read-only

The status of the webhook

signing_key_id
string
read-only

KSUID of the endpoint's active signing key. Empty when the endpoint has not opted into signing.

signing_key_created_at
string<date-time>
read-only

The time the active signing key was created.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

previous_key_expires_at
string<date-time>
read-only

The time the previous key stops being valid. Present only during the rotation overlap window.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"