Event Reference

The Event Reference documents the webhook payloads delivered by Plextera to endpoints configured via Event Subscriptions.


How events are delivered

Plextera sends an HTTP POST to your endpointUrl with a JSON body and a set of standard headers. Every delivery is signed with your signingSecret — see Verifying signatures.

Plextera deduplicates terminal events per subscription: each job or run reaches a terminal state exactly once, so at most one delivery is attempted per event type per subscription.


Common envelope

All events share the same top-level structure:

1{
2 "eventId": "evt_01JY7M9QWBWCPMZK5QJ7RSE9P4",
3 "eventType": "document-insights.job.completed",
4 "occurredAt": "2026-04-07T10:22:00Z",
5 "apiVersion": "v1",
6 "data": { ... }
7}
FieldDescription
eventIdUnique event identifier. Stable across retry attempts for the same event.
eventTypeEvent type string.
occurredAtISO 8601 timestamp when the terminal state was reached.
apiVersionAPI version used to format the payload (e.g., v1).
dataEvent-specific payload. See each event type below.

Document Insights events

document-insights.job.completed

Delivered when a Document Insights job reaches COMPLETED. The data payload includes the job state and the output field with the final extraction result.

The output shape is ExtractionOutput — a fieldCount and a fields array with typed field values, confidence scores, and page placement coordinates.

document-insights.job.failed

Delivered when a Document Insights job reaches FAILED. The data.error field contains a machine-readable code and a human-readable message describing the failure.

document-insights.job.rejected

Delivered when a Document Insights job reaches REJECTED. Rejection occurs before or during validation — the document was never processed. The data.error field describes the reason (e.g., broken or empty file, unsupported language, duplicate document).


Workflow events

workflow.run.completed

Delivered when a workflow run reaches COMPLETED. The data payload includes the full run state, step-level outputs, and nested run summaries where applicable.

workflow.run.failed

Delivered when a workflow run reaches FAILED. The data.error field describes the failure, and data.steps shows which step failed and its last known status message.


Event type summary

Event typeTriggered whendata.output present
document-insights.job.completedDI job → COMPLETEDExtractionOutput
document-insights.job.failedDI job → FAILED
document-insights.job.rejectedDI job → REJECTED
workflow.run.completedWorkflow run → COMPLETEDStep outputs in steps
workflow.run.failedWorkflow run → FAILED