Sign in

v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB
/webhooks

Receive asynchronous notifications (partner webhook)

Specification for the webhook endpoint your application hosts to receive asynchronous notifications from Suki when ambient session processing completes or fails. Suki sends POST requests to your configured notification URL.

post/webhooks/notification

Request body

encounter_idstring

Id of the encounter to which the payload belongs.

error_codestring

Error code.

error_detailstring

Details of the error, if any.

session_idstring

Id of the session that failed.

statusstring

Example request

{
  "encounter_id": "29de56bc-960a-4cd5-b18f-79a798d62874",
  "error_code": "ERROR_CODE_TRANSCRIPTION",
  "error_detail": "Error in transcription",
  "session_id": "20965414-929a-4f71-a3e5-b92bec07d086",
  "status": "failure"
}

Response

OK