For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • API Reference
  • Event Reference
      • POSTWorkflow run completed
      • POSTWorkflow run failed
Event ReferenceWorkflows

Workflow run failed

Payload
1{
2  "eventId": "evt_01JY7MWFFAIL00000000001",
3  "eventType": "workflow.run.failed",
4  "occurredAt": "2026-04-07T10:12:30Z",
5  "apiVersion": "v1",
6  "data": {
7    "runId": "69d224901610662a576cd7e6",
8    "workflowId": "daily-correspondence-loader",
9    "status": "FAILED",
10    "createdAt": "2026-04-07T10:10:00Z",
11    "updatedAt": "2026-04-07T10:12:30Z",
12    "completedAt": "2026-04-07T10:12:30Z",
13    "workflow": {
14      "id": "daily-correspondence-loader",
15      "name": "Daily Correspondence Loader"
16    },
17    "progress": {
18      "stepsCompleted": 1,
19      "stepsTotal": 3
20    },
21    "steps": [
22      {
23        "id": "step_01",
24        "name": "Extracted Document",
25        "type": "document_insights",
26        "status": "COMPLETED",
27        "nestedRuns": {
28          "count": 0,
29          "data": []
30        }
31      },
32      {
33        "id": "step_02",
34        "name": "Route Result",
35        "type": "web_function",
36        "status": "FAILED",
37        "message": "Client endpoint rejected the request.",
38        "nestedRuns": {
39          "count": 0,
40          "data": []
41        }
42      }
43    ],
44    "error": {
45      "code": "WORKFLOW_RUN_FAILED",
46      "message": "Client endpoint rejected the request."
47    }
48  }
49}

Delivered when a workflow run reaches FAILED.

Was this page helpful?
Previous
Built with

Headers

X-Plextera-Delivery-IdstringRequired

Unique identifier for this delivery attempt. Changes on each retry; use X-Plextera-Event-Id for deduplication.

X-Plextera-Event-IdstringRequired
Stable event identifier. Identical across retry attempts for the same event. Use this to deduplicate deliveries on the receiver side.
X-Plextera-Event-TypestringRequired

Event type string, e.g. document-insights.extraction.completed. Mirrors the eventType field in the body.

X-Plextera-Event-Occurred-AtdatetimeRequired

ISO 8601 timestamp when the terminal state was reached. Mirrors the occurredAt field in the body.

X-Plextera-Api-VersionstringRequired

API version used to format this payload, e.g. v1. Mirrors the apiVersion field in the body.

X-Plextera-SignaturestringRequired

HMAC-SHA256 signature for verifying that the delivery originated from Plextera. Format: t=<unix timestamp>,v1=<hex signature>. The signed string is <t>.<raw request body>. See the Events guide for full verification steps.

Payload

The payload of this webhook request is an object.
eventIdstringRequired

Unique identifier for this event. Stable across retry attempts — use it to deduplicate deliveries on the receiver side.

eventType"workflow.run.failed"Required

String identifying the event type, e.g. document-insights.extraction.completed.

occurredAtdatetimeRequired
ISO 8601 timestamp at which the terminal state was reached.
apiVersionstringRequired
API version used to format this payload.
dataobjectRequired

Event-specific payload. The shape varies by eventType; see the individual event schemas below.

Response

200
Event accepted
202
Event accepted for asynchronous processing