environment.health_changed
A check finds the environment in a different health than before.
When this fires
The scheduled check calls the environment's health-check address every few minutes, and a monitoring system or a person can record what they observed over the API; whichever wrote the health, this fires only when it differs from the health before, so a healthy environment checked all day stays quiet. A status page or a chat alert subscribes here; the maintenance module will open an incident when a production environment stays down.
Related events
environment.updated: a change to the check's address, which is an edit rather than a health change.
Ability to subscribe
A token needs this to subscribe an endpoint to the event.
Header Parameters
t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now.
The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.
The event name, the same as the envelope's type.
Always application/json.
Always ZuseBifrost-Webhooks/1.0.
Payload
JSONWhat Zuse Bifrost posts to your endpointapplication/json
The signed JSON envelope posted to your endpoint.
The envelope every event is delivered in.
Responses
2XXAny success status
Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.
defaultAny other status
Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from Settings → Webhook Deliveries or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.
How is this guide?
Last updated on