Webhooks
Receive document.exported events and payload structure
Webhooks
Webhooks send extracted data to your URLs when a document is processed.
Setting up webhooks
- Open your parser and go to Settings → Integrations.
- Under Available Integrations, click Webhook.
- Expand Webhook export, add one or more endpoint URLs, then click Save.
Event type: document.exported
Triggered when a document has been extracted, post‑processed, and (if reviews are enabled) approved. Requests are delivered by Svix. The request body is JSON with this shape:
{
"extracted_data": {
"Invoice Number": "INV-001",
"Total": "1,234.56",
"Date": "2024-01-15"
},
"metadata": {
"id": "doc_123",
"name": "Invoice INV-001",
"url": "https://app.digiparser.com/document/doc_123",
"isProcessed": true,
"assignee": null,
"event": "document.exported",
"teamId": "team_123",
"teamSlug": "acme-co",
"parserId": "parser_123",
"workflowId": "workflow_123"
}
}- extracted_data – Your parser’s fields (and tables) as key–value pairs. Keys match your field names; values are strings.
- metadata – Document and context:
id,name,url,isProcessed,assignee,event,teamId,teamSlug,parserId,workflowId.
Webhook security
Signature verification
Each request includes Svix headers you can use to verify it came from DigiParser and was not modified:
svix-id: ...
svix-timestamp: ...
svix-signature: ...Use these with the signing secret shown for each endpoint in the Webhook export settings. See How to verify webhooks for details and code samples.
HTTPS
Webhook URLs must use HTTPS.
Testing webhooks
In Settings → Integrations → Webhook export, expand an endpoint and use Send test webhook to send a sample payload to your URL.
How is this guide?
Authentication
How to authenticate API requests
Get Document Data GET
Retrieve the extracted data from a processed document. **What you need:** - **Parser ID**: Find it in Parser Settings → General Settings - **Document ID**: Get this from the upload response (`documentId` field) - **API Key**: Generate it from Team Settings → API Keys **How to use:** - Endpoint: `GET /api/v1/process/{parserId}/files/data?documentId={documentId}` - Include your API key in the `Authorization` header **What you get:** - **data**: Extracted field values and table data matching your parser's schema - **metadata**: Document information including status, timestamps, and file details **Note:** If the document is still processing, the `data` field will be empty and `status` will be `processing`. Poll this endpoint periodically until `status` is `processed` or `failed`.