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
      • POSTExtract Run Processed
      • POSTExtract Run Failed
      • POSTExtractor Created
      • POSTExtractor Updated
      • POSTExtractor Deleted
      • POSTExtractor Draft Updated
      • POSTExtractor Version Published
LogoLogo
Webhook EventsExtract

Extractor Created

Payload
1{
2  "eventId": "string",
3  "payload": {
4    "object": "extractor",
5    "id": "ex_Xj8mK2pL9nR4vT7qY5wZ",
6    "name": "Invoice Extractor",
7    "createdAt": "2024-03-21T16:45:00Z",
8    "updatedAt": "2024-03-21T16:45:00Z",
9    "draftVersion": {
10      "object": "extractor_version",
11      "id": "exv_xK9mLPqRtN3vS8wF5hB2cQ",
12      "description": "Updated extraction fields for new invoice format",
13      "version": "draft",
14      "config": {
15        "schema": {}
16      },
17      "extractorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
18      "createdAt": "2024-03-21T16:45:00Z"
19    }
20  },
21  "eventType": "extractor.created"
22}
Was this page helpful?
Previous

Extractor Updated

Next
Built with

Payload

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

Response

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