Skip to main content
POST
/
your-analysis-webhook-url
Webhook callback for checklist analysis results
curl --request POST \
  --url https://app.xosum.am/your-analysis-webhook-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "secret": "<string>",
  "docId": "<string>",
  "analysisId": "<string>",
  "metadata": {},
  "checklistId": "<string>",
  "checklistName": "<string>",
  "results": {},
  "link": "<string>"
}
'
You host this endpoint. Xosum sends this payload to a webhook URL you host whenever a checklist analysis finishes for a transcription that was created with a checklistId. The path /your-analysis-webhook-url is a placeholder for whatever publicly-reachable URL you configure in your account.
Verify the secret field matches your webhookSecret, return 200 OK quickly, and process the results map asynchronously. Each entry in results is keyed by the checklist question ID; see AnalysisResultEntry in the schema below for the per-question shape.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
event_type
enum<string>

Event type for checklist analysis completion.

Available options:
analysis_ready
​
secret
string

Webhook secret to validate authenticity.

​
docId
string

Transcription/recording job ID.

​
analysisId
string

Analysis document ID.

​
metadata
object

Metadata passed during creation.

​
checklistId
string | null

Checklist ID used for this analysis (if present).

​
checklistName
string | null

Checklist name snapshot captured at analysis time (if present).

​
results
object

Map keyed by checklist question ID, where each value contains the analysis result.

​
link
string<uri>

Direct URL to the recording details inside Xosum.am.

Response

Webhook received and acknowledged.