API reference · Schema
CreateWebhookRequest
urlstringrequiredWhere 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
descriptionstringFree-text description
up to 500 characters
event_typesarray of stringEvent 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_eventsbooleanAlso 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
- Create a webhook destination (its signing secret is returned once)
POST /v1/webhooks