V-Spark Online Help

Configure Callbacks

V‑Spark folders use callbacks to send transcription and analysis results to a pre-configured location when processing is complete.

For more information on callbacks, including information about retry logic when a callback fails, refer to Using Callbacks in V‑Spark in the V‑Spark API Reference.

The following is a general workflow for configuring callbacks for V‑Spark folders:

  1. Navigate to the Create New Folder or Update Folder dialog. Refer to the following topics for more information on configuring new or existing folders:

  2. Enable the Configure callback delivery method option on the second page of the Create New Folder or Update Folder dialog.

  3. Click Next to navigate to callback configuration options.

  4. Configure callbacks for the folder using the following fields:

    1. Automatically send... — Enable any of the following output types:

      JSON

      Sends a JSON version of the transcript and its associated metadata. JSON output is enabled by default.

      MP3

      Sends a post-transcription MP3 version of the transcribed audio file. This MP3 contains redacted audio if redaction is enabled for the folder.

      Text

      Sends a plaintext version of the transcript.

    2. Callback Delivery Method — Use the dropdown to select a delivery method, and enter its path in the textbox. V‑Spark supports the following delivery methods:

      Table 1. Callback Delivery Types

      Delivery Method

      Description

      Required Parameters

      Example

      http:// and https://

      Standard hypertext transfer protocol. Callbacks are sent to a web server listening on a specified or default port. HTTPS runs over Secure Socket Layer (SSL).

      Delivery path

      update-folder-callbacks-http.png

      File system

      Callback data is written to a specified location on the host system on which V‑Spark is installed.

      Important

      When using the file system method, V‑Spark's user group must be set to vocisrv, and that user group must have write permissions for the specified directory path.

      Local filesystem directory path

      update-folder-callbacks-fs.png

      SFTP

      Callbacks are sent to a server using the Secure File Transfer Protocol (SFTP).

      Username and password

      OR

      SSH private key

      update-folder-callbacks-sftp.png

      AWS S3

      Callback data is written to the Amazon Web Service (AWS) Simple Storage Service (S3).

      AWS access key ID and secret

      update-folder-callbacks-aws.png

      OAuth https://

      As with standard HTTPS, callbacks are sent to a web server listening on a specified or default port, but the callback is authenticated with OAuth credentials instead of a username and password.

      Client ID, client secret, grant type, and token URL

      update-folder-callbacks-oauth.png