session.created or note.generated. Ambient and Form filling notifications use a top-level status of SUCCESS or FAILURE. CKG ingestion notifications use a top-level state of COMPLETED, FAILED, or ABORTED. On success and CKG payloads, check additional_info.session_type (AMBIENT, FORM_FILLING, or CKG_INGESTION) when one callback URL receives more than one product.
Event type, trigger, and payload
Delivery, signature, and retries
Suki sends one HTTP POST to your partner callback URL when a session or CKG job reaches a terminal outcome. Your endpoint must return HTTP 200 within 30 seconds. If delivery fails, Suki retries up to four more times (5 attempts total). Before you trust the body, verify theX-API-Key header (HMAC-SHA-256 hex) and the generated-at timestamp. Return 200 after you accept the notification, then run follow-up work asynchronously when you can.
For setup and verification steps, see Overview, Signature verification, and Configuration.
Browse events
No webhook events match.
Try a different search term, or widen the filters.
Ambient Session Completion
Ambient status: SUCCESS
Note generation finished. The payload identifies the session and encounter and includes
Note generation finished. The payload identifies the session and encounter and includes
_links to retrieve results.Ambient Session Failure
Ambient status: FAILURE
Processing failed or the session was aborted. Use
Processing failed or the session was aborted. Use
error_code and error_detail to log, alert, or show an error.Form Filling Session Completion
Form Filling status: SUCCESS
Form filling finished. Use
Form filling finished. Use
_links.structured_data for form output and _links.status for session state.Form Filling Session Failure
Form Filling status: FAILURE
Form filling failed or was aborted. Use
Form filling failed or was aborted. Use
error_code and error_detail to decide whether to retry, alert, or surface the error.CKG Ingestion Completed
CKG state: COMPLETED
FHIR push ingestion finished. CKG notifications use
FHIR push ingestion finished. CKG notifications use
state, not status, and include transaction_id for correlation.CKG Ingestion Failed
CKG state: FAILED
FHIR push ingestion failed during processing. The payload includes an
FHIR push ingestion failed during processing. The payload includes an
error object with details.CKG Ingestion Aborted
CKG state: ABORTED
Ingestion stopped before it finished, for example because the upload expired. An
Ingestion stopped before it finished, for example because the upload expired. An
error object may be present.Example payloads
The following examples show the JSON body your callback URL receives. For field definitions and linked API response codes, see Payload & response.Ambient session completion
Ambient status: SUCCESS When an Ambient session completes successfully, Suki sends a payload that can look like the following:_links to retrieve note content, structured data, transcripts, or session status.
Ambient session failure
Ambient status: FAILURE When an Ambient session fails or is aborted, Suki sends a payload that can look like the following:Form filling session completion
Form Filling status: SUCCESS When a Form filling session finishes successfully, Suki sends a payload that can look like the following:structured_data link to retrieve filled medical form instances. Other _links arrays are empty on Form filling webhooks.
Form filling session failure
Form Filling status: FAILURE When a Form filling session fails, Suki sends a payload that can look like the following:CKG ingestion completed
CKG state: COMPLETED When a FHIR push ingestion job completes successfully, Suki sends a payload that can look like the following:CKG ingestion failed
CKG state: FAILED When a FHIR push ingestion job fails, Suki sends a payload that can look like the following:CKG ingestion aborted
CKG state: ABORTED When ingestion is aborted, for example because the upload expired, Suki sends a payload that can look like the following:Suki does not send separate timeout or cancellation webhooks. If a session fails or is aborted, you get
status: FAILURE. If processing finishes, you get status: SUCCESS. For Ambient, that SUCCESS can still arrive when the recording was silent or too short and session status is skipped, so confirm status before you treat the visit as note-ready. See Webhook event types.