Skip to navigation
WebhooksCage

Cage deleted

Sent when a cage is deleted. The payload is the cage as it was before deletion.

Headers

SignaturestringRequiredformat: "^[0-9a-f]{64}$"

Lowercase hex-encoded HMAC-SHA256 of the raw request body, keyed with your webhook’s signing secret. Compute it over the bytes exactly as received, before parsing, and compare in constant time.

Payload

The payload of this webhook request is an object.
idstringRequiredformat: "^whe_[a-zA-Z0-9]{10,22}$"
Unique identifier for a webhook event. A retried delivery carries the same identifier, so use it to discard duplicates.
eventenumRequired
The event that occurred.
Allowed values:
versionenumRequired
A released version of the public API. Each OAuth client is registered against one version, which determines the response shape it receives.
Allowed values:
created_atdatetimeRequired

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

payloadobjectRequired
A cage in your facility, including its generated catalog number, assigned study, and metadata.
client_idstringOptionalformat: "uuid"
The OAuth client whose API request caused the event. Omitted when the event did not originate from an API request, and on events that never carry it.

Response

2XX
Any 2xx status acknowledges the delivery, which is then not retried. The response body is ignored.