Skip to main content

What to expect in the Webhook Payload

For the File Transcription API, every time the status of your transcription job changes you will receive the following json payload in your webhook endpoint. Make sure to register a webhook endpoint by following the instructions here

JSON Payload

{
"eventType": "transcription",
"data": {
"fileId": "<YOUR-FILE-ID>",
"language": "<LANGUAGE-CODE>",
"transcribeId": "<YOUR-TRANSCRIBE-ID>",
"fileName": "...",
"transcriptionStatus": "Transcribing",
"transcriptionProgress": [
"Queued",
"Loading Model",
"Model Loaded",
"Preparing File",
"Transcribing"
],
"apikey": "<YOUR-APIKEY>",
"appType": "transcription",
"duration": 767,
"fileSize": 0,
"domain": "<YOUR-DOMAIN>",
"suburl": "...",
"message": "...",
"createAt": 1667205327349,
"transcribingTime": 0,
"timestamp": [],
"transcripts": "......",
"publicUrl": "https://platformlargefilestore.blob.core.windows.net/common/uploads/<YOUR-FILE-ID>"
}
}

Every time the transcriptionStatus changes you will receive a new object with a new transcriptionStatus and updated field values. E.g., when transcriptionStatus becomes Completed then you will see values in the timestamp and transcripts field.

Failure Handling

When transcription fails due to some reason the transcriptionStatus field is set to Failed. Whenever that happens you can handle the failure case with some custom logic.