Webhooks

Balance events

Sent when your available balance is $1.00 or less, or below $0.50, to each enabled webhook that lists the event, from a check about once a minute. balance.low: the available balance is between $0.50 and $1.00; it is sent again only after the balance has gone back above $2.00. balance.depleted: the available balance is below $0.50 and running workloads are being stopped. A balance that falls from above $1.00 to below $0.50 between two checks sends balance.depleted alone. The check covers an organization with a VM or pod running, with auto-recharge on, or with compute usage not yet billed. A balance-exempt organization gets neither event, and a check that starts an auto-recharge sends neither. Listing a balance event needs billing read access.

postWebhookbalanceEvent

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'balance.low' | 'balance.depleted' 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.