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:
Represents the version of the event. This uses semantic versioning to inform a consumer if the payload has introduced any breaking changes.
Represents the type of the event described in the payload.
An identifier representing this specific event.
An object representing the event, whose fields are described below.
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
The semantic version of the current message.
The Unix epoch time in seconds representing when the event was generated.
The payload of the object, describing the given event.
The batch processor job id.
The preset given when starting the job.
These parameters define what the inputs were for this given batch processor job.
The source type describing the input of the job.
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.
If uri sourceType, this field represents the BCP-47 language of the transcript.
These parameters define the output of the batch processor job.
If this job generated a SOAP output, this field will be defined.
If this job generated concepts output, this field will be defined.
If this job generated summary output, this field will be defined.
If this job generated transcriptions output, this field will be defined.