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 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    },
26    "result": {
27      "parseRun": {
28        "object": "parse_run",
29        "id": "pr_xK9mLPqRtN3vS8wF5hB2cQ",
30        "file": {
31          "object": "file",
32          "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
33          "name": "Invoices.pdf",
34          "type": "PDF",
35          "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
36          "metadata": {},
37          "createdAt": "2024-03-21T16:45:00Z",
38          "updatedAt": "2024-03-21T16:45:00Z"
39        },
40        "status": "PENDING",
41        "failureReason": "FILE_TYPE_NOT_SUPPORTED",
42        "failureMessage": "File type not supported for parsing.",
43        "output": {
44          "chunks": [
45            {
46              "object": "chunk",
47              "type": "page",
48              "content": "This is the content of the chunk.",
49              "metadata": {
50                "pageRange": {
51                  "start": 1,
52                  "end": 1
53                }
54              },
55              "blocks": [
56                {
57                  "object": "block",
58                  "id": "string",
59                  "type": "text",
60                  "content": "string",
61                  "details": {},
62                  "metadata": {},
63                  "polygon": [
64                    {
65                      "x": 10,
66                      "y": 20
67                    }
68                  ],
69                  "boundingBox": {
70                    "left": 10,
71                    "top": 10,
72                    "right": 20,
73                    "bottom": 20
74                  }
75                }
76              ]
77            }
78          ]
79        },
80        "outputUrl": "https://...",
81        "metrics": {
82          "processingTimeMs": 1234,
83          "pageCount": 5
84        },
85        "config": {},
86        "usage": {
87          "credits": 9
88        }
89      }
90    }
91  },
92  "eventType": "workflow_run.step_run.processed"
93}
Was this page helpful?
Previous

Workflow Created

Next
Built with

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