Webhook Callback
Webhook callback
Once configured during initialization, it is possible to receive a callback once the transcription is complete and results are ready for retrieval.
⚠️ API Change (May 2020)
Due to authorization issues with providing the transcript in the callback, Scriptix no longer includes results in the HTTPS callback. It is now required for the customer to retrieve the results themselves using the result endpoint.
Callback URLs
The callback URL must meet the following conditions, in addition to being a valid HTTPS URL:
- Must use
HTTPS - Cannot be
localhostor use.localdomain - Cannot be an IP address (IPv4 or IPv6)
- Must be publicly resolvable for the API
Callback message
The Scriptix API will always call the configured HTTPS endpoint with the following message. You may configure custom headers (e.g., for authentication), but the headers listed below cannot be overridden.
Callback headers
The following headers are always present:
| Header | Value | Description |
|---|---|---|
| X-Zoom-Session | sessionId | The Scriptix Transcript Session ID |
| X-Scriptix-Session | sessionId | The Scriptix Transcript Session ID |
| Content-Type | application/json | The content type of the callback message |
Callback body
The callback body is a JSON object with the following keys:
| Key | Type | Description |
|---|---|---|
| sessionId | string | The Scriptix Transcript Session ID |
| zoom_id | string | The Scriptix Transcript Session ID |
Automatic retry
The customer’s HTTPS webhook endpoint must respond with a 2XX status code within 20 seconds, or the request will be marked as failed. If the callback fails, automatic retries will be attempted with the following schedule:
| Delay | Time after transcript complete |
|---|---|
| 00:00 | Immediately |
| 01:00 | 1 minute later |
| 02:00 | 3 minutes later |
| 05:00 | 8 minutes later |
| 15:00 | 23 minutes later |
| 30:00 | 53 minutes later |
If the callback fails after all retries, it is abandoned, and no further notification is sent.
⚠️ Only successful transcripts receive a callback
Currently, only successful transcriptions result in a callback. If a transcription fails for any reason, no callback is made.