Automation overview — Zapier, MCP and webhooks
Compare private Zapier connectors, OAuth-delegated MCP tools, signed project webhooks and REST API orchestration, with deployment prerequisites and limitations.
Pick the right automation surface#
PDFHQ offers different integration surfaces rather than a single REST endpoint named Zapier or MCP. The task API powers processing; project webhooks deliver events; an unpublished Zapier Platform CLI app wraps permitted REST operations; MCP exposes delegated OAuth tools for AI agents.
Direct API: documented task, upload, AI and signing routes are accessible with the appropriate credentials and account permissions. Zapier: source is available in integrations/zapier but there is no published app. MCP: local server exists; hosted OAuth is staging gated and not certified public. Webhooks: source endpoints exist but return 503 unless enabled by an operator after setup and testing.
Example: PDF job → webhook → automation#
First submit a project-owned PDF task using the normal API lifecycle. Subscribe to the completed event only after your deployment has activated customer webhooks, encryption and the delivery worker. Store the returned signing secret once; verify the exact raw payload and reject replay before triggering downstream automation.
# Staging only: project API key stored on your server.
curl -X POST 'https://api.pdfhq.io/v1/webhooks' \
-H 'x-api-key: YOUR_PROJECT_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"target_url":"https://your-app.example/events/pdfhq","events":["pdf.job.succeeded","ai.job.succeeded"]}'
# The first response includes a one-time HMAC signing secret.
# Verify X-PDFHQ-Webhook-Timestamp and X-PDFHQ-Webhook-Signature: v1=...;
# reject old messages and deduplicate on the event ID.The webhook payload contains metadata, not PDF bytes or signed download links. Retrieve any permitted results independently through authenticated PDFHQ APIs. Delivery is at least once, so consumers must handle duplicates.
Webhook events, verification, retries and replay →Zapier: private app source#
Project-key authentication enables PDF/AI job triggers and actions, with signed REST Hooks for supported project events and polling fallback. An authorized document must already be uploaded through the sealed upload flow. The app can only prepare unsent sandbox signature drafts; it cannot dispatch live invitations.
cd integrations/zapier
npm install
npm test
npx zapier-platform validateValidate the connector with a Zapier developer account and staging API before publishing anything. This repository does not contain a public Zapier listing or a one-click install link.
Zapier triggers, actions and limitations →MCP: delegated AI-agent access#
MCP uses HQTools OAuth Authorization Code + PKCE and audience-verified PDFHQ scopes. It is not an API-key variant of Zapier and does not receive webhooks. Local stdio can be tested with a separately obtained short-lived token; hosting a remote MCP server requires operator configuration, PKCE and lifecycle acceptance.
https://mcp.pdfhq.io/mcpPermitted tools include PDF job status/submission, AI quotes/jobs and limited signing status. Redaction, deletion, live signing dispatch and credential administration are deliberately excluded from autonomous tools. AI execution continues through HQTools credit and consent rules.
MCP OAuth scopes and staging setup →Other workflow systems#
Native Make and n8n connectors are not implemented or published. Their HTTP modules can call documented REST operations, and compatible HTTPS endpoints can receive project webhooks once enabled. Do not configure production workflows until project auth, event signatures, billing and retries pass connected tests.
Build with the REST task quickstart →