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.
Book a demoLog in
DocumentationAPI ReferenceModel VersioningChangelog
DocumentationAPI ReferenceModel VersioningChangelog
    • Authentication
    • API Versioning
    • Deployments
    • Error Handling
  • Endpoints
  • Webhook Events
      • POSTExtract Run Processed
      • POSTExtract Run Failed
      • POSTExtractor Created
      • POSTExtractor Updated
      • POSTExtractor Deleted
      • POSTExtractor Draft Updated
      • POSTExtractor Version Published
LogoLogo
Book a demoLog in
Webhook EventsExtract

Extract Run Processed

Payload
1{
2  "eventId": "string",
3  "payload": {
4    "object": "extract_run",
5    "id": "exr_Xj8mK2pL9nR4vT7qY5wZ",
6    "status": "PROCESSING",
7    "output": {
8      "value": {},
9      "metadata": {}
10    },
11    "initialOutput": {
12      "value": {},
13      "metadata": {}
14    },
15    "reviewedOutput": {
16      "value": {},
17      "metadata": {}
18    },
19    "failureReason": "PARSING_ERROR",
20    "failureMessage": "string",
21    "metadata": {},
22    "reviewed": false,
23    "edited": false,
24    "edits": {},
25    "config": {
26      "schema": {}
27    },
28    "extractor": {
29      "object": "extractor",
30      "id": "ex_Xj8mK2pL9nR4vT7qY5wZ",
31      "name": "Invoice Extractor",
32      "createdAt": "2024-03-21T16:45:00Z",
33      "updatedAt": "2024-03-21T16:45:00Z"
34    },
35    "extractorVersion": {
36      "object": "extractor_version",
37      "id": "exv_xK9mLPqRtN3vS8wF5hB2cQ",
38      "description": "Updated extraction fields for new invoice format",
39      "version": "draft",
40      "extractorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
41      "createdAt": "2024-03-21T16:45:00Z"
42    },
43    "file": {
44      "object": "file",
45      "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
46      "name": "Invoices.pdf",
47      "type": "PDF",
48      "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
49      "metadata": {},
50      "createdAt": "2024-03-21T16:45:00Z",
51      "updatedAt": "2024-03-21T16:45:00Z"
52    },
53    "parseRunId": "pr_Xj8mK2pL9nR4vT7qY5wZ",
54    "dashboardUrl": "https://dashboard.extend.ai/runs/exr_Xj8mK2pL9nR4vT7qY5wZ",
55    "usage": {
56      "credits": 9
57    },
58    "createdAt": "2024-03-21T16:45:00Z",
59    "updatedAt": "2024-03-21T16:45:00Z"
60  },
61  "eventType": "extract_run.processed"
62}
Was this page helpful?
Previous

Extract Run Failed

Next
Built with

Payload

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

Response

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