← Back to schema index

CreateWebhookRequest

Body for `POST /v1/webhooks` with the receiving HTTPS URL, subscribed events, and an optional label.

Properties

FieldTypeDescription
url*string (uri)URL that receives the webhook. It is rejected if it resolves to a private address or is longer than 2048 characters and, in production, also if it does not use HTTPS.
events*arrayEvents the endpoint subscribes to, from 1 to 10.
descriptionstring | nullFree-form label to tell this endpoint apart from the others. `null` omits it; more than 255 characters responds `422 webhook_description_too_long`.

Used in operations

  • POST /v1/webhooks