Webhooks

Dedicated endpoint events

Sent when one of your dedicated inference endpoints changes state, to each enabled webhook that lists the event, usually within seconds of the change. endpoint.ready: the endpoint serves requests, after it was created or enabled. endpoint.disabled: the endpoint was disabled and its requests are refused; an endpoint deleted before this was sent sends it first. endpoint.deleted: the endpoint was deleted, its last event. Listing an endpoint event needs endpoint read access. Delivery is at least once: the same change can occasionally arrive twice, with the same event id. Each delivery is attempted on its own, so events can arrive out of order: order an endpoint's events by data.at.

postWebhookendpointEvent

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 endpoint entered the state, RFC 3339 in UTC to the second.

idstring required

The event's id, evt_ followed by a UUID. It derives from the endpoint, the state and when the endpoint entered it, so the same change recorded twice is one event. A retry of a delivery carries the same id.

type'endpoint.ready' | 'endpoint.disabled' | 'endpoint.deleted' 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.