Sign in

v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0462198511.0 KB
webhooks

Create a webhook

Create a new webhook.

post/webhooks

Request body

descriptionstring

Human-readable purpose of the webhook.

urlstring required

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

Example request

{
  "url": "https://example.com/webhook"
}

Response

Created

created_atstring date-time required

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

descriptionstring nullable required

Webhook purpose.

idstring required

Unique resource identifier.

is_activeboolean required

Whether the webhook is active.

modified_atstring date-time required

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

secretstring required

Signing secret returned when the webhook is created.

urlstring required

Webhook destination URL.