work_item.ranked
An item takes a new place in the project's order.
When this fires
A person drags a card on the Board page to a new place in its column or another, or a token calls the rank endpoint with the neighbour the item goes before or after. The payload carries the position the item took, so a mirror of the tracker keeps the same order; a move that leaves the position as it was emits nothing, and the items renumbered around it when the order ran out of room emit nothing either.
Related events
work_item.transitioned: the column the item moved into, when the drag changed it as well.
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