Document Processed | Invofox

{
  "id": "675e1a2b8f7d06899790871d",
  "timestamp": 1702649400000,
  "version": "1.2",
  "data": {
    "_id": "66d71d63c9d0d2adc038b076",
    "account": "670d9bcfb5cea6e5fe12e012",
    "environment": "68bf5564dd7ffc7f33c0fc91",
    "company": "66d5dc3afed4f8062c998439",
    "name": "invoice-2024-001.pdf",
    "creation": "2024-09-26T10:30:00.000Z",
    "data": {
      "total": 1250.5,
      "date": "2024-09-26",
      "invoiceNumber": "INV-001"
    },
    "pageCount": 1,
    "publicState": "processed",
    "creator": {},
    "clientData": {},
    "type": "invoice",
    "images": [],
    "original": "https://...",
    "mimetype": "application/pdf",
    "confidence": "high",
    "validationInfo": {
      "errors": [
        {
          "validation": "required",
          "info": {},
          "paths": [
            "data.documentNumber"
          ]
        }
      ]
    },
    "import": {},
    "lockedAt": {},
    "lockedBy": {},
    "lockExpiredAt": {},
    "postponed": false,
    "hasQuestions": false,
    "workQueue": {},
    "skippedBy": [],
    "knownData": {}
  },
  "type": "document.processed",
  "url": ""
}

Document processing complete with extracted data.

Payload Format:

Data fields contain direct values (e.g., {"total": 100})
Validation errors include validation, info, and paths fields
Document type field may contain built-in type name, custom type alias, or ObjectId for custom types
Timestamp uses Unix milliseconds format
The url field is typically an empty string (maintained for compatibility)

Document processing complete with extracted data. **Payload Format:** - Data fields contain direct values (e.g., `{"total": 100}`) - Validation errors include `validation`, `info`, and `paths` fields - Document `type` field may contain built-in type name, custom type alias, or ObjectId for custom types - Timestamp uses Unix milliseconds format - The `url` field is typically an empty string (maintained for compatibility)

Payload

The payload of this webhook request is an object.

idstringRequired

Unique identifier for this event (use for idempotent processing)

timestampdouble or stringRequired

Event timestamp

versionstringRequired

Version of the event schema

dataobjectOptional

Document structure returned in webhooks and GET /documents/:id endpoint.

Data Format:

Data fields contain direct values: {"total": 100}
Validation errors include validation, info, and paths fields
Document type can be a built-in type name, custom type alias, or ObjectId for custom types

Document structure returned in webhooks and GET /documents/:id endpoint. **Data Format:** - Data fields contain direct values: `{"total": 100}` - Validation errors include `validation`, `info`, and `paths` fields - Document type can be a built-in type name, custom type alias, or ObjectId for custom types

typeenumOptional

Allowed values:

urlstringOptional

URL field (typically empty string for security)

Response

200

any

Return a 200 status to indicate that the data was received successfully.