← Back to schema index

UpdateWebhookRequest

Body used to change a webhook receiver: its address, the events it listens to, and whether it stays active.

Properties

FieldTypeDescription
urlstring (uri)HTTPS destination URL. Replaces the previous URL when provided.
eventsarrayWebhook event subscription. Replaces the previous list; max 10 events.
descriptionstring | nullFree-form webhook label (`null` to clear it).
statusstringChanges the webhook state (`active` or `disabled`).

Used in operations

  • PUT /v1/webhooks/{id}