Workflow Run Step Run Processed

Payload

1 {
2   "eventId": "string",
3   "payload": {
4     "object": "workflow_step_run",
5     "id": "workflow_step_run_xK9mLPqRtN3vS8wF5hB2cQ",
6     "workflowRunId": "workflow_run_xKm9pNv3qWsY_jL2tR5Dh",
7     "stepType": "PARSE",
8     "status": "PROCESSED",
9     "files": [
10       {
11         "object": "file",
12         "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
13         "name": "Invoices.pdf",
14         "type": "PDF",
15         "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
16         "metadata": {},
17         "createdAt": "2024-03-21T16:45:00Z",
18         "updatedAt": "2024-03-21T16:45:00Z"
19       }
20     ],
21     "step": {
22       "object": "workflow_step",
23       "id": "step_xK9mLPqRtN3vS8wF5hB2cQ",
24       "name": "Validate Invoice Total",
25       "type": "PARSE"
26     },
27     "result": {
28       "parseRun": {
29         "object": "parse_run",
30         "id": "pr_xK9mLPqRtN3vS8wF5hB2cQ",
31         "file": {
32           "object": "file",
33           "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
34           "name": "Invoices.pdf",
35           "type": "PDF",
36           "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
37           "metadata": {},
38           "createdAt": "2024-03-21T16:45:00Z",
39           "updatedAt": "2024-03-21T16:45:00Z"
40         },
41         "status": "PENDING",
42         "failureReason": "FILE_TYPE_NOT_SUPPORTED",
43         "failureMessage": "File type not supported for parsing.",
44         "metadata": {},
45         "output": {
46           "chunks": [
47             {
48               "object": "chunk",
49               "type": "page",
50               "content": "This is the content of the chunk.",
51               "metadata": {
52                 "pageRange": {
53                   "start": 1,
54                   "end": 1
55                 }
56               },
57               "blocks": [
58                 {
59                   "object": "block",
60                   "id": "string",
61                   "type": "text",
62                   "content": "string",
63                   "details": {},
64                   "metadata": {},
65                   "polygon": [
66                     {
67                       "x": 10,
68                       "y": 20
69                     }
70                   ],
71                   "boundingBox": {
72                     "left": 10,
73                     "top": 10,
74                     "right": 20,
75                     "bottom": 20
76                   }
77                 }
78               ]
79             }
80           ]
81         },
82         "outputUrl": "https://...",
83         "metrics": {
84           "processingTimeMs": 1234,
85           "pageCount": 5
86         },
87         "config": {},
88         "usage": {
89           "credits": 9
90         }
91       }
92     }
93   },
94   "eventType": "workflow_run.step_run.processed"
95 }

Payload

The payload of this webhook request is an object.

eventIdstringRequired

Unique identifier for the event

payloadobjectRequired

A workflow step run. The shape of the result field depends on the stepType.

Response

200

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