Job Finished

A batch processor job finished event is emitted when as batch processor job enters the finished status. Read more about batch processor jobs here.

Webhook Events

There are five common fields all events share:

string

Represents the version of the event. This uses semantic versioning to inform a consumer if the payload has introduced any breaking changes.

string

Represents the type of the event described in the payload.

string

An identifier representing this specific event.

object

An object representing the event, whose fields are described below.

number

Documenting when the webhook itself was sent. This timestamp is different than the time of the event the webhook describes. For example, a recording.started event will contain a start_ts timestamp of when the actual recording started, and a slightly later event_ts timestamp indicating when the webhook event was sent.

Payload

string

The semantic version of the current message.

string

The type of event that is being provided.

Options: "batch-processor.job-finished"
number

The Unix epoch time in seconds representing when the event was generated.

object

The payload of the object, describing the given event.

string

The batch processor job id.

string

The preset given when starting the job.

string

The status of the job.

Options: "finished"
object

These parameters define what the inputs were for this given batch processor job.

The source type describing the input of the job.

Options: "recordingId","uri","transcriptUri"
string

If uri or transcriptUri sourceType, this field represents the uri to access the content (transcript, video or audio file).

If recordingId sourceType, this field represents the id of the recording.

string

If uri sourceType, this field represents the BCP-47 language of the transcript.

object

These parameters define the output of the batch processor job.

object

If this job generated a SOAP output, this field will be defined.

string

The filetype of this SOAP note.

Options: "JSON"
object

The S3 bucket configuration for this file.

string

The s3 bucket containing this file.

string

The s3 object location of this file.

string

The s3 bucket region.

object

If this job generated concepts output, this field will be defined.

string

The filetype of these concepts.

Options: "JSON"
object

The S3 bucket configuration for this file.

string

The s3 bucket containing this file.

string

The s3 object location of this file.

string

The s3 bucket region.

object

If this job generated summary output, this field will be defined.

string

The filetype of this summary.

Options: "txt"
object

The S3 bucket configuration for this file.

string

The s3 bucket containing this file.

string

The s3 object location of this file.

string

The s3 bucket region.

If this job generated transcriptions output, this field will be defined.