Skip to content
Hayonix

API reference · Schema

CreateWebhookRequest

  • urlstringrequired

    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 · default ["*"]

  • org_eventsboolean

    Also receive organization events (billing: low balance, out of credit, payments, auto-recharge). Needs billing:read.

    default false

Example
{
  "url": "https://hooks.example.com/platform",
  "description": "Ops alerts",
  "event_types": [
    "pod.stopped",
    "pod.host_lost"
  ],
  "org_events": false
}

Used by