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:
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.