Skip to content
Hayonix

API reference · Schema

UpdateWebhookRequest

  • urlstring

    Where events are POSTed: an https URL (plain http is accepted only by development deployments). Addresses that resolve to loopback, private, link-local or metadata networks are refused when delivering.

    1–2048 characters

  • descriptionstring

    Free-text description

    up to 500 characters

  • event_typesarray of string

    Event types to receive, or `["*"]` for every type (GET /v1/webhooks/event-types lists them). Organization events (billing) need `org_events: true`.

    1–64 items

  • org_eventsboolean

    Also receive organization events (billing). Turning it on needs billing:read.

  • statusstring

    `paused` stops sending (pending deliveries are given up; redeliver them after resuming); `active` resumes and clears the failure streak.

    One ofactivepaused

Example
{
  "status": "active"
}

Used by