Partner APIReference
Events
The event catalog, envelope and reconciliation stream.
Event types
- order.created
- order.updated
- order.cancelled
- specimen.updated
- result.partial
- result.final
- result.corrected
- result.critical
- integration.action_required
These are the only event types the platform emits. There is no other event family, and no delivery guarantee beyond what is documented here.
Envelope
event_id— unique identifier; deduplicate on it.type— one of the event types above.version— payload version; currently1.occurred_at— when the underlying fact happened.environment—sandboxorproduction.program_id— the program the event belongs to, when applicable.data— allow-listed identifiers and coarse state only.
Reconciliation
GET
/v1/eventsRead the event stream for reconciliationThe stream is cursor-paged: pass cursor from the previous response's next_cursor and an optional limit. It requires the events:read scope.
- A webhook event carries identifiers and coarse state only. Analyte values, patient demographics, report documents, headers and secrets are never present.
- The authoritative state is always the API: GET /v1/orders/{orderId}/results for released structured results, and GET /v1/orders/{orderId}/results/{resultId} for one version.
- Deliveries are at-least-once and may arrive out of order. Deduplicate on event_id and treat the highest released result version from the API as current.
- A missed or failed delivery never loses data: replay the ordered stream from GET /v1/events using the cursor, then re-read the results endpoint.
- result.partial and result.final describe the same append-only lineage; a partial version remains retrievable after the final version is released.
- result.corrected signals a new superseding version. The prior version is retained and reported as superseded rather than removed.
- result.critical is an escalation signal only. Retrieve the critical workflow state and the observations from the result endpoint.
- A report document is retrieved per request through the governed report endpoint. No permanent or signed document URL is ever delivered in an event.