← Back to schema index

UpdateWebhookRequest

Body for `PUT /v1/webhooks/{id}` with the endpoint fields to update.

Properties

FieldTypeDescription
urlstring (uri)New receiver URL. It is rejected if it does not resolve to a public address or is longer than 2048 characters and, in production, also if it does not use HTTPS.
eventsarrayNew events the endpoint subscribes to. They replace the previous list. Between 1 and 10.
descriptionstring | nullNew free-form label to tell this endpoint apart from the others. `null` clears it; more than 255 characters responds `422 webhook_description_too_long`.
statusstringWebhook status. `active` receives deliveries; `disabled` stops them.

Used in operations

  • PUT /v1/webhooks/{id}