Version
WEBHOOK

work_item.checklist_changed

An entry of an item's Definition of Ready or Definition of Done is ticked, unticked, added or removed.

When this fires

A person ticks or unticks an entry in the item's flyout, adds or removes one there, a token replaces a list or ticks an entry over the API, or an agent calls tick_checklist_item. The payload carries which list and its tally after the change, so a mirror shows the same progress and a listener knows when the gate opened; a change that leaves the list as it was emits nothing.

Related events

  • work_item.transitioned: the move into done the Definition of Done lets through.

Ability to subscribe

A token needs this to subscribe an endpoint to the event.

Header Parameters

ZG-Signature*string

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.

ZG-Event-Id*string

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.

ZG-Event-Name*string

The event name, the same as the envelope's type.

Content-Type*string

Always application/json.

User-Agent*string

Always ZuseBifrost-Webhooks/1.0.

Payload

JSONWhat Zuse Bifrost posts to your endpoint

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