Skip to main content
Documate can notify your systems and your team when a file is accepted or a document finishes. You choose which events to send and where they go: webhook, email, or in-app.

​
Where you set this up

​
Business defaults

Open Business → Integrations & events.
  1. Turn Enabled on.
  2. Enter the HTTPS URL Documate should POST to.
  3. Optionally set a shared secret (used to sign the POST).
  4. Tick the events you want on the webhook.
  5. Save.
Use Webhook deliveries on the same page to review recent POSTs.

​
Channel override

Open Channels & intake → Intake.
  • Leave Inherit Business defaults on to use the business webhook URL, secret, and event ticks.
  • Uncheck inherit to set a different URL, secret, and event list for this channel only. Email and in-app still follow the business settings.
Live delivery uses the effective channel webhook config (inherited or overridden).

​
How events are sent

When a subscribed event happens, Documate does the following for each enabled destination that has that event ticked: Nothing is sent if that destination is off, or if the event is not ticked. Events are not sent when:
  • You use sync extract (api_sync).
  • You only poll the partner API. Polling does not create events.
  • The file or document never reaches that state (for example a document that stays Processing).

​
Available events

The app shows Title Case labels. Webhooks use the dotted key.
Typical partner setup: tick File received (to fetch the original file) plus Document ready and Document failed (to ingest or alert). Add File completed if you only want a signal when the whole pack succeeded.

​
Test a webhook

On Business → Integrations & events, use Test next to the webhook URL. Documate posts a sample payload for a recent file or document.
  • Test POSTs include X-Documate-Test: true.
  • Signing still uses your secret when one is configured. Verify X-Documate-Signature; do not treat the test header as authentication.
  • Test prefers the business secret you just saved. Live traffic still uses the effective channel config.

​
Payload and verification

Webhooks never include raw file bytes. You get IDs and optional short-lived download URLs. See Webhooks for the JSON shape, headers, and how to download the original file after file.received. See API webhooks for signature samples.