Skip to main content
POST
/
your-webhook-url
Webhook callback for transcription results
curl --request POST \
  --url https://app.xosum.am/api/your-webhook-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "secret": "<string>",
  "docId": "<string>",
  "transcription": "<string>",
  "metadata": {
    "phonenumber": "+37400000000",
    "agent": "King Ruzi"
  },
  "title": "<string>",
  "resolution": "<string>",
  "link": "<string>"
}
'

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
secret
string

Webhook secret to validate authenticity.

​
docId
string

Transcription job ID.

​
transcription
string

The fully diarized text result of the transcription.

​
metadata
object

Metadata passed during creation.

Example:
{
  "phonenumber": "+37400000000",
  "agent": "King Ruzi"
}
​
title
string

Short title automatically generated from the transcript.

​
resolution
string

A concise summary or resolution for the call.

​
link
string<uri>

Direct URL to the recording details inside Xosum.am.

Response

Webhook received and acknowledged.