webhooks

Create a webhook

Create a new webhook.

post/webhooks

Request body

descriptionstring

Optional description of what the webhook is used for.

urlstring required

The URL of the webhook. Note that the URL must use HTTPS and must not be an IP address.

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

Created

created_atstring date-time required

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

descriptionstring nullable required

Optional description of what the webhook is used for.

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

The signing secret for this webhook. This is only exposed once at creation so please store it securely.

urlstring required

The URL of the webhook.