Skip to content

Event catalogue

Generated from packages/events’s EVENT_CATALOGUE — the single source of truth webhook producers and this page both build from. Envelope version 2026-09-01.

Event Description
exchange.created A referral or letter was created and accepted for processing.
exchange.rejected An exchange failed validation or was denied by the consent policy decision point.
exchange.routed A connector (native or fallback) was selected and the exchange handed to it.
exchange.delivered The exchange reached the recipient (native inbox or fallback channel).
exchange.accessed A fallback secure-link recipient opened the delivered document (read receipt).
exchange.failed Delivery failed after the retry ladder was exhausted.
exchange.acknowledged The recipient acknowledged receipt of the exchange.
document.ready An ingested document finished processing and is ready (high-confidence classification).
document.needs_review An ingested document finished processing and needs human review.
document.accepted A reviewer accepted a document extraction into the clinical record.
document.rejected A document was rejected — at ingestion (infected/unsupported) or by a reviewer.
consent.changed A consent record was created or superseded.
patient.duplicate_override A patient was created despite a demographic collision (force=true).
webhook_endpoint.disabled A webhook endpoint was auto-disabled after sustained delivery failure.