Job Error

A batch processor error event is emitted when as batch processor job enters the error 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"
integer

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: "error"
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"

If the sourceType is uri, this field will be present containing the URI for the transcript.

If the sourceType is recordingId, this field will be present containing the recording ID provided.

string

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

string

A description of the error that occurred.