Webhooks

VM and pod events

Sent when a VM starts, or a VM or pod stops, is terminated, is interrupted or recovers, to each enabled webhook that lists the event or lists none. vm.running: a VM reached running from deploying, on its first start, on every later start of a stopped or failed VM and on every restart, a reboot of a running VM included; or a VM or pod recovered from an interruption. A pod's start, first or later, sends none. vm.stopped: a VM or pod was stopped. vm.terminated: a VM or pod was terminated. vm.interrupted: a VM or pod stopped serving through no action of yours, for example because its node went offline. It usually recovers on its own and sends vm.running again; one still interrupted after 7 days, or whose node is removed, is ended instead: a pod as terminated, which sends vm.terminated, and a VM as stopped, which sends no event. The events cover the VMs and pods your organization lists; the nodes of a managed Kubernetes cluster send none. Delivery is at least once: the same change can occasionally be recorded as a second event, with a new event id and a new delivery id.

postWebhookvmEvent

Headers

X-OpenRelay-Signaturestring required

sha256= followed by the lowercase hex HMAC-SHA256 of the raw request body. The HMAC key is the 64 character lowercase hex SHA-256 of your whole whsec_ secret, prefix included, used as those characters rather than decoded from hex. Verify it over the exact bytes received, before parsing them. Only the body is signed: there is no timestamp. The signing secret is read at each attempt, so a retry after a regenerate is signed with the new secret.

X-OpenRelay-Eventstring required

The event's type, the same as the body's type.

X-OpenRelay-Deliverystring uuid required

The id of this delivery to this webhook, a UUID. Every retry of the delivery carries the same id and the same body, so deduplicate on it.

User-Agent'OpenRelay-Webhook/1.0' required
X-VectorLay-Signaturestring required

The same value as X-OpenRelay-Signature, under the name used before OpenRelay. Deprecated, to be removed in a future release: verify X-OpenRelay-Signature.

X-VectorLay-Eventstring required

The same value as X-OpenRelay-Event. Deprecated, to be removed in a future release: read X-OpenRelay-Event.

X-VectorLay-Deliverystring uuid required

The same value as X-OpenRelay-Delivery. Deprecated, to be removed in a future release: read X-OpenRelay-Delivery.

Payload

created_atstring date-time required

When the event was recorded, RFC 3339 in UTC to the second.

idstring required

The event's id, evt_ followed by a UUID, new each time an event is recorded. A retry of a delivery carries the same id.

type'vm.running' | 'vm.stopped' | 'vm.terminated' | 'vm.interrupted' required

Response

Delivered. Any 2xx status within 10 seconds counts, and its body is not kept.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.