Webhook (Transcripts)

POST{{your_url}}/your-path

This particular configuration is available in Transcript workspaces, which deal with transcribed text from audio or video files.

The notification sends all transcription data in JSON format, containing all transcribed paragraphs, their speakers, start and end time, and annotations.

The following options are available:

• Endpoint: a publicly available URL where SmartDocumentor can send notifications to. Notifications are sent as HTTP POST requests, with a JSON body.

• Simplified Export: when enabled, SmartDocumentor sends a simplified model that only contains key information, such as detected paragraphs and speakers. When disabled, SmartDocumentor sends all metadata, including auditing information and annotations.

Example Request

Normal Export

{
    "taskId": 0,
    "originalFileUrl": "string", // nullable
    "workspaceId": 0,
    "displayName": "string",
    "description": "string", // nullable
    "taskNumber": 1, // nullable 
    "batchId": 1, // nullable
    "totalTimeInSeconds": 0,
    "lastCheckoutByUserName": "string", // nullable
    "lastCheckedOutBy": 0, // nullable
    "lastCheckedOutUntil": "2023-05-31T13:30:59.671Z", // nullable
    "lastIntegratedBy": 0, // nullable
    "lastIntegratedByUserName": "string", // nullable
    "lastIntegratedOn": "2023-05-31T13:30:59.671Z", // nullable
    "transcript": {
        "transcripts": [
            {
                "speakerId": "string",
                "start": 0, // double
                "end": 0, // double
                "duration": 0, // double
                "confidence": 0.95, // double, varies from 0 (0%) to 1 (100%)
                "displayText": "string",
                "displayWords": [
                    {
                        "text": "string",
                        "offsetInSeconds": 0, // nullable, double
                        "durationInSeconds": 0, // nullable, double
                        "confidence": 0.95 // double, varies from 0 (0%) to 1 (100%)
                    }
                ],
                "originalWords": [
                    {
                        "text": "string",
                        "offsetInSeconds": 0, // nullable, double
                        "durationInSeconds": 0, // nullable, double
                        "confidence": 0.95 // double, varies from 0 (0%) to 1 (100%)
                    }
                ],
                "annotations": [
                    {
                        "uniqueId": "string",
                        "content": "string",
                        "start": 0, // double
                        "end": 0, // double
                        "createdByUserName": "string",
                        "createdBy": 0,
                        "createdOn": "string",
                        "modifiedByUserName": "string",
                        "modifiedBy": 0,
                        "modifiedOn": "string"
                    }
                ]
            }
        ],
        "speakers": [
            {
                "speakerId": "string",
                "speakerName": "string",
                "speakerPrefix": "string", // nullable
                "speakerSuffix": "string" // nullable
            }
        ]
    },
    "metadata": { // has any number of key/value pairs
        "Key_1": "Value_1" // strings non nullable, key will be unique throughout the metafields
    }
}

Simplified Export

{
    "taskId": 0,
    "originalFileUrl": "string", // nullable
    "workspaceId": 0,
    "displayName": "string",
    "description": "string", // nullable
    "taskNumber": 1, // nullable 
    "batchId": 1, // nullable
    "totalTimeInSeconds": 0,
    "lastCheckoutByUserName": "string", // nullable
    "lastCheckedOutBy": 0, // nullable
    "lastCheckedOutUntil": "2023-05-31T13:30:59.671Z", // nullable
    "lastIntegratedBy": 0, // nullable
    "lastIntegratedByUserName": "string", // nullable
    "lastIntegratedOn": "2023-05-31T13:30:59.671Z", // nullable
    "transcript": {
        "transcripts": [
            {
                "speakerId": "string",
                "start": 0,
                "end": 0,
                "duration": 0,
                "confidence": 0,
                "displayText": "string"
            }
        ],
        "speakers": [
            {
                "speakerId": "string",
                "speakerName": "string",
                "speakerPrefix": "string", // nullable
                "speakerSuffix": "string" // nullable
            }
        ]
    },
    "metaFields": { // has any number of key/value pairs
        "Key_1": "Value_1" // strings non nullable, key will be unique throughout the metafields
    }
}

originalFileUrl contains a SAS token secured URL, pointing to the original upload of your file. This URL has the following characteristics:

• It is only set if the "Delete document files after finishing review" setting is disabled in the Workspace -> Advanced Settings screen, otherwise its null

• The URL will expire after a default maximum of 180 days. You can configure this value by setting "Days until deletion of documents in archive" in the Workspace -> Advanced Settings screen.

• If the document is deleted either manually or when the maximum retention date is reached, future requests to this URL will return 404 Not Found.

• Once the URL expires, requests will return 403 Forbidden.

When working with an automatically split document, all document properties, including taskId, originalFileUrl, displayName, taskNumber and totalTimeInSeconds will be set for the originally split document.

Use this request as an example below of what JSON is sent in a webhook integration. This integration method includes additional detail, such as individually detected words, precise timestamps, and annotations. Unless otherwise stated, numeric values are integers.