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 ReferenceChangelogModel Versioning
GuidesAPI ReferenceChangelogModel Versioning
    • Getting Started
    • Authentication
    • API Versioning
    • SDKs
    • Deployments
    • Error Codes
    • Async Processing
  • Endpoints
  • Webhook Events
      • POSTWorkflow Run Completed
      • POSTWorkflow Run Failed
      • POSTWorkflow Run Needs Review
      • POSTWorkflow Run Rejected
      • POSTWorkflow Run Cancelled
      • POSTWorkflow Run Step Run Processed
      • POSTWorkflow Created
      • POSTWorkflow Deployed
      • POSTWorkflow Deleted
LogoLogo
Webhook EventsWorkflow

Workflow Run Cancelled

Payload
1{
2  "eventId": "string",
3  "payload": {
4    "object": "workflow_run",
5    "id": "workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
6    "workflow": {
7      "object": "workflow",
8      "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
9      "name": "Invoice Processing",
10      "createdAt": "2024-03-21T16:45:00Z",
11      "updatedAt": "2024-03-21T16:45:00Z"
12    },
13    "workflowVersion": {
14      "object": "workflow_version",
15      "id": "workflow_version_Zk9mNP12Qw4-yTv8BdR3H",
16      "version": "1",
17      "name": "Production v1",
18      "createdAt": "2024-03-21T16:45:00Z"
19    },
20    "dashboardUrl": "https://dashboard.extend.ai/workflows/workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
21    "status": "PENDING",
22    "metadata": {},
23    "batchId": "batch_7Ws31-F5",
24    "files": [
25      {
26        "object": "file",
27        "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
28        "name": "Invoices.pdf",
29        "type": "PDF",
30        "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
31        "metadata": {},
32        "createdAt": "2024-03-21T16:45:00Z",
33        "updatedAt": "2024-03-21T16:45:00Z"
34      }
35    ],
36    "failureReason": "string",
37    "failureMessage": "string",
38    "initialRunAt": "2025-04-28T17:01:39.285Z",
39    "reviewedByUser": "jane.doe@example.com",
40    "reviewed": true,
41    "rejectionNote": "string",
42    "reviewedAt": "2024-03-21T16:45:00Z",
43    "startTime": "2024-03-21T15:30:00Z",
44    "endTime": "2024-03-21T15:35:00Z",
45    "stepRuns": [
46      {
47        "object": "workflow_step_run",
48        "id": "workflow_step_run_xK9mLPqRtN3vS8wF5hB2cQ",
49        "workflowRunId": "workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
50        "stepType": "PARSE",
51        "status": "PROCESSED",
52        "files": [
53          {
54            "object": "file",
55            "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
56            "name": "Invoices.pdf",
57            "type": "PDF",
58            "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
59            "metadata": {},
60            "createdAt": "2024-03-21T16:45:00Z",
61            "updatedAt": "2024-03-21T16:45:00Z"
62          }
63        ],
64        "step": {
65          "object": "workflow_step",
66          "id": "step_xK9mLPqRtN3vS8wF5hB2cQ",
67          "name": "Validate Invoice Total"
68        },
69        "result": {
70          "parseRun": {
71            "object": "parse_run",
72            "id": "pr_xK9mLPqRtN3vS8wF5hB2cQ",
73            "file": {
74              "object": "file",
75              "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
76              "name": "Invoices.pdf",
77              "type": "PDF",
78              "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
79              "metadata": {},
80              "createdAt": "2024-03-21T16:45:00Z",
81              "updatedAt": "2024-03-21T16:45:00Z"
82            },
83            "status": "PENDING",
84            "failureReason": "FILE_TYPE_NOT_SUPPORTED",
85            "failureMessage": "File type not supported for parsing.",
86            "output": {
87              "chunks": [
88                {
89                  "object": "chunk",
90                  "type": "page",
91                  "content": "This is the content of the chunk.",
92                  "metadata": {
93                    "pageRange": {
94                      "start": 1,
95                      "end": 1
96                    }
97                  },
98                  "blocks": [
99                    {
100                      "object": "block",
101                      "id": "string",
102                      "type": "text",
103                      "content": "string",
104                      "details": {
105                        "type": {},
106                        "rowCount": {},
107                        "columnCount": {}
108                      },
109                      "metadata": {},
110                      "polygon": [
111                        {
112                          "x": 10,
113                          "y": 20
114                        }
115                      ],
116                      "boundingBox": {
117                        "left": 10,
118                        "top": 10,
119                        "right": 20,
120                        "bottom": 20
121                      }
122                    }
123                  ]
124                }
125              ]
126            },
127            "outputUrl": "https://...",
128            "metrics": {
129              "processingTimeMs": 1234,
130              "pageCount": 5
131            },
132            "config": {},
133            "usage": {
134              "credits": 9
135            }
136          }
137        }
138      }
139    ],
140    "usage": {
141      "credits": 9
142    }
143  },
144  "eventType": "workflow_run.cancelled"
145}
Was this page helpful?
Previous

Workflow Run Step Run Processed

Next
Built with

Payload

The payload of this webhook request is an object.
eventIdstringRequired
Unique identifier for the event
payloadobjectRequired
Workflow run object.

Response

200
Return a 200 status to indicate that the webhook was received successfully