Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
API ReferenceComputeWebhooks

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. endpoint.failed: the endpoint's model did not start, its replicas failing before they were ever ready on every hardware shape it runs on; its replicas are stopped, and the endpoint's stateReason says why. endpoint.scaled_to_zero: the endpoint went to sleep under its scaling policy's idle rule, after a window with no request; its replicas are stopped and unbilled. endpoint.waking: the endpoint is starting its replicas again, because a request reached it while it slept or an off window of its schedule ended; requests are answered 503 endpoint_waking until a replica serves, and endpoint.ready follows. 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.

Header Parameters

X-OpenRelay-Signature*string

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.

Match^sha256=[0-9a-f]{64}$
X-OpenRelay-Event*string

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

X-OpenRelay-Delivery*string

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.

Formatuuid
User-Agent*"OpenRelay-Webhook/1.0"
Value in"OpenRelay-Webhook/1.0"
X-VectorLay-Signature*stringDeprecated

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.

Match^sha256=[0-9a-f]{64}$
X-VectorLay-Event*stringDeprecated

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

X-VectorLay-Delivery*stringDeprecated

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

Formatuuid

Request Body

application/json
  1. body

The body of an endpoint.ready, endpoint.disabled, endpoint.deleted, endpoint.failed, endpoint.scaled_to_zero or endpoint.waking delivery.

id*string

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*string
Value in"endpoint.ready""endpoint.disabled""endpoint.deleted""endpoint.failed""endpoint.scaled_to_zero""endpoint.waking"
created_at*string

When the endpoint entered the state, RFC 3339 in UTC to the second.

Formatdate-time
data*

Response Body

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

Example Requests
POST/endpointEvent

The body of an endpoint.ready, endpoint.disabled, endpoint.deleted, endpoint.failed, endpoint.scaled_to_zero or endpoint.waking delivery.

Request Body
application/json
{  "id": "evt_…",  "type": "endpoint.ready",  "created_at": "2026-10-25T12:00:00Z",  "data": {    "endpoint_id": "de_…",    "model_id": "acme/support-bot",    "state": "ready",    "version": 3,    "at": "2026-10-25T12:00:00.123456789Z"  }}
Header Parameters
{  "X-OpenRelay-Signature": "string",  "X-OpenRelay-Event": "string",  "X-OpenRelay-Delivery": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "User-Agent": "OpenRelay-Webhook/1.0",  "X-VectorLay-Signature": "string",  "X-VectorLay-Event": "string",  "X-VectorLay-Delivery": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}