Skip to main content

Events

Receive real-time notifications for extraction events including extraction.complete, extraction.failed, and document.ingested via webhook URLs.

Receive real-time notifications when extraction events occur. Configure webhook URLs per-source or per-extraction via the webhook_url option.

Available webhook events:

Most integrations subscribe to extraction.complete to trigger downstream processing (e.g. writing structured data to a database or notifying a user). A typical workflow is to pass webhook_url on POST /v1/extract, then handle the callback payload in your server without polling.

The extraction.complete payload includes the extraction_id, document_id, schema_id, status, and confidence score. Use the extraction_id to fetch the full result via GET /v1/extractions/:id if the payload does not contain all the fields you need.

Pair event handling with [Signature Verification](webhook-security) to ensure payloads are authentic. Note that extraction.failed events include an error field with a machine-readable code and human-readable message — use this to decide whether to retry via POST /v1/extract with document_id.

Webhook URLs must be HTTPS endpoints. HTTP URLs are rejected at configuration time to ensure payload confidentiality in transit.