For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Documentation API Reference Webhooks Reference

Documentation API Reference Webhooks Reference

- Webhook Implementation
- Processing Tracking
Document Processing
File Processing
- POSTFile Processed
- POSTFile Rejected
Import Processing
- POSTImport Processed

Webhook Implementation
Processing Tracking
Document Created
Document Processed
Document Approved
Document Discarded
File Processed
File Rejected
Import Processed

File Processing

File Processed

Payload

1 {
2   "type": "file.processed",
3   "version": "1.2",
4   "id": "675e1a2b8f7d06899790871d",
5   "timestamp": "2024-12-15T14:30:00.000Z",
6   "data": {
7     "id": "68dafdea5bc8034cce794278",
8     "accountId": "670d9bcfb5cea6e5fe12e012",
9     "environmentId": "68bf5564dd7ffc7f33c0fc91",
10     "status": "processed",
11     "filename": "4510678297.pdf",
12     "documentIds": [
13       "66d71d63c9d0d2adc038b076",
14       "66d71d63c9d0d2adc038b077"
15     ],
16     "importId": "66d711d737c788ba24e17734",
17     "clientData": {}
18   }
19 }

File processing complete with generated document IDs

Was this page helpful?

File Rejected

Payload

The payload of this webhook request is an object.

typeenumRequired

The type of event

versionstringRequired

Version of the event schema

idstringRequired

Unique identifier for this event (use for idempotent processing)

timestampstringRequiredformat: "date-time"

ISO 8601 timestamp when the event occurred

dataobjectRequired

Event payload with relevant information

Response

200

Webhook received successfully