Webhook IntegrationWebhooks for DocuShell PDF automation.
Send real-time, signed PDF job events from DocuShell to n8n, Zapier, Make, Airtable, databases, CRMs, and your own backend. Stop polling. Let completed PDFs move the next workflow forward.
Works with
DocuShell
API
Submit your job with a webhook URL
DocuShell processes your PDF
DocuShell
API
Your app
/webhook
{ "event": "job.completed" }Signed POST event fires when your job completes
Your app
/webhook
Delivers to n8n, Zapier, Airtable, or any HTTPS URL
How It Works
A webhook turns every PDF job into an automation trigger.
The pattern is intentionally simple: submit work, let DocuShell process it, receive a signed event, then hand off to whatever system owns the next step.
Submit a PDF job
Send Parse PDF, Resume Parse, PDF to Word, compression, Markdown to PDF, or Webpage to PDF work through the DocuShell API.
DocuShell processes it
The job runs in a queued lane with status tracking, validation, rate limits, and one-time artifact downloads.
Webhook POST fires
When the job finishes or fails, DocuShell sends a signed JSON event to the endpoint you supplied.
Your workflow takes over
n8n, Zapier, Make, Airtable, your backend, or a database function can route the result without polling.
Automation Destinations
Built for the tools teams already use.
Any service that can receive an HTTP POST can receive a DocuShell webhook. That makes integrations practical before a native marketplace connector exists.
Self-hosted flows
n8n
Catch a DocuShell event, branch by service, fetch artifacts, and move parsed data into your internal stack.
No-code routing
Zapier
Trigger Zaps when PDFs are parsed, compressed, converted, or rendered from a webpage.
Visual scenarios
Make
Build multi-step scenarios that enrich PDF outputs, notify teams, and archive results.
Operations records
Airtable
Create rows from parsed invoices, resumes, forms, and research packets with minimal glue code.
API Setup
Add a webhook URL to the job request.
Webhooks are job-specific today, which is ideal for API builders and automation workflows. Saved dashboard endpoints and delivery history can sit on top of the same event model later.
Create or choose your webhook endpoint
Use an n8n webhook node, a Zapier catch hook, a Make custom webhook, a serverless function, or your own API route.
Submit a DocuShell job with webhook fields
Use a Pro, Growth, or Scale API key, then pass a webhook URL and required secret in your request. Multipart, JSON, and raw PDF endpoints each support the pattern that fits their request shape.
Verify and acknowledge the event
Check the signature against the raw request body, enqueue your own downstream work, and respond with 2xx quickly.
Submit a Parse PDF job with a webhook
curl -X POST "https://api.docushell.com/api/v1/parse" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: invoice-parse-001" \
-F "file=@./invoice.pdf;type=application/pdf" \
-F "output_mode=all" \
-F "webhook_url=https://example.com/webhooks/docushell" \
-F "webhook_secret=replace-with-a-long-secret"Example completion event
{
"event": "pdf.parse.completed",
"job_id": "job_7c53d9f4",
"service": "parse-pdf",
"status": "done",
"credits_cost": 12,
"completed_at": "2026-05-20T09:24:18.000Z",
"links": {
"status": "https://api.docushell.com/api/v1/jobs/job_7c53d9f4",
"download": "https://api.docushell.com/api/v1/jobs/job_7c53d9f4/download"
},
"output": {
"filename": "invoice.parsed.zip",
"size_bytes": 24576,
"page_count": 12,
"expires_at": "2026-05-20T10:24:18.000Z"
}
}Payload and Security
Small JSON events, clear links, and verification hooks.
A webhook event should be easy to inspect and easy to trust. DocuShell sends the job status, service name, useful timestamps, and links your integration can use for status checks or artifact downloads.
Signed delivery
Add the required webhook secret and verify the DocuShell signature before your endpoint trusts the event.
Retry-friendly
Return a 2xx response when accepted. Job webhooks retry with progressive backoff; parse batch webhooks use short bounded retry.
Private network guardrails
Webhook URLs must be HTTPS and pass the same defensive URL validation philosophy used across DocuShell APIs.
No long polling
Your app does not need to keep checking job status. The completion event arrives when there is useful work to do.
Delivery Contract
Verify first, dedupe always, acknowledge fast.
DocuShell signs the raw JSON body with HMAC-SHA256 using your webhook secret. Verify the signature before parsing or trusting the payload, then store the delivery id so retries cannot duplicate downstream work.
Acknowledge within 10 seconds
Persist the event or enqueue downstream work, then return any 2xx response. Non-2xx responses and timeouts are treated as delivery failures.
Handle retries
Non-batch job webhooks make up to 6 attempts with progressive backoff. Parse batch webhooks are best-effort terminal notifications, so keep polling as your source of truth.
Deduplicate deliveries
Use x-docushell-delivery with event and job_id or batch_id. Receiver code should be idempotent because retries may reach your endpoint more than once.
Test with public HTTPS
Localhost, private, reserved, and metadata-service addresses are blocked. Use a public HTTPS staging endpoint or approved tunnel for local receiver tests.
Delivery headers and signature input
POST /webhooks/docushell
content-type: application/json
user-agent: DocuShell-Webhooks/1.0
x-docushell-event: pdf.parse.completed
x-docushell-delivery: 9e5f2d7e-0d59-4ad8-a3d2-26b13e914f35
x-docushell-timestamp: 1770000000
x-docushell-signature: t=1770000000,v1=<hmac_sha256>[,v1=<previous_secret_hmac_during_rotation>]
Signature message:
1770000000.<raw JSON request body>Event Reference
Every API webhook is a terminal job or batch event.
Subscribe per job by including webhook fields at submit time. Completion events point to the status and download links; failure events include an error and failure code when available.
PDF jobs
pdf.parse.completed, pdf.parse.failed, pdf.parse.batch.completed, pdf.parse.batch.completed_with_failures, pdf.parse.batch.failed, pdf.compress.completed, pdf.compress.failed, pdf.to_word.completed, pdf.to_word.failed
Generated PDFs
markdown.to_pdf.completed, markdown.to_pdf.failed, url.render.completed, url.render.failed
Resume parsing
resume.parse.completed, resume.parse.failed, resume.batch.completed, resume.batch.completed_with_failures, resume.batch.failed
Use Cases
Why webhooks matter for DocuShell customers.
Webhooks turn PDF utilities into business workflows. The user gets a faster handoff, the business gets fewer manual status checks, and developers get a stable event contract for custom systems.
Parse supplier PDFs, then create Airtable records for finance operations.
Send resume parsing results to an ATS, CRM, or recruiting database.
Compress PDFs before archiving them in a document management workflow.
Render webpage receipts or reports to PDF, then notify a customer success channel.
Push structured JSON into a data warehouse, internal API, or post-processing function.
Trigger human review only when a PDF job fails or confidence rules need attention.
FAQ
Practical webhook questions.
The short version: webhooks make DocuShell easier to plug into automation tools and easier to sell to teams with existing systems.
Do users configure webhooks from the DocuShell dashboard?
Today webhooks are available through Pro, Growth, and Scale API requests themselves, so a developer or automation builder can attach a destination to each job. The dashboard integrations page is the natural place for saved endpoints and delivery logs as that UI grows.
Will this make n8n, Zapier, Make, and Airtable easier?
Yes. Those tools already know how to receive HTTP webhook events. DocuShell can send a completion event, and the workflow tool can fetch the final artifact, map fields, route alerts, or create records.
What events can DocuShell send?
The webhook system supports terminal completion and failure events for PDF parsing, parse batches, resume parsing, Markdown to PDF, webpage rendering, PDF compression, PDF to Word, and resume batches.
Do webhooks replace the jobs API?
No. Webhooks remove the need for constant polling, while the jobs API remains useful for status screens, downloads, retries, and explicit customer support checks.
Turn DocuShell API jobs into live business workflows.
Start with one webhook URL, then expand into saved dashboard endpoints, workflow templates, native connectors, and delivery logs as demand grows.