Webhooks Overview
Receive HTTP callbacks from DocuClipper when documents finish processing — delivered to your own endpoints.
Webhooks let DocuClipper notify your systems when work finishes. Whenever a document is converted, an invoice is approved, or an automation completes a run, DocuClipper can POST a payload to a URL you control. Your server handles the rest.
When to use webhooks
- You're building a custom workflow (e.g. push extracted data straight into your CRM, accounting, or data warehouse).
- You want real-time status updates instead of polling the DocuClipper API.
- You want to trigger downstream automation in tools like Zapier, Make, or n8n — most of which accept webhook URLs natively.
If all you need is a basic export to an accounting system, a direct QuickBooks or Xero download or an automation with a cloud-folder output are simpler.
Creating a webhook
- Open Webhooks from the left sidebar.
- Click New webhook.
- Paste the target URL. The URL must be HTTPS and respond with a 2xx status within 10 seconds.
- Choose which events to subscribe to (e.g.
job.completed,invoice.approved). - Save. DocuClipper generates a signing secret you can use to verify payloads (see below).
Payload shape
Every webhook delivery is a POST with JSON. Each payload includes:
id— unique delivery ID.event— event name (job.completed, etc.).occurredAt— ISO 8601 timestamp.data— event-specific body. Forjob.completedthis includes the job ID, document metadata, and the extracted data payload.
Verifying signatures
Each delivery includes an X-DocuClipper-Signature header: an HMAC-SHA256 of the request body using the webhook's signing secret. Recompute the HMAC on your end and compare in constant time — reject any request whose signature doesn't match.