Notify Webhook

The Notify Webhook feature allows DocsAutomator to send notifications to external services when documents are successfully generated. This enables integration with other applications and workflows.

Purpose

Notify other services about successful document creations through webhook callbacks, allowing you to trigger downstream processes or log document generation events in external systems.

Configuration

Webhook URL Registration

Register a webhook address that will receive notifications once documents are created. DocsAutomator makes POST requests to your specified endpoint when generation completes.

Open the Actions card

In the automation editor, open the Actions card in the right rail and click Add action

Add the webhook action

Pick Webhook or AI agent from the action list and keep Webhook under Send to

Enter URL

Enter your webhook endpoint URL

Test

Click Send test, or generate a preview document

Headers

Open Headers in the card to add request headers, for example an API key. Each value is stored encrypted, shown afterwards as dots ending in its last 4 characters, and sent only to the address it was saved for. After you change the webhook URL to another address, enter the header values again. Each field saves when you leave it. Click Send test to send a sample document with the saved settings and see whether your endpoint accepted it. The webhook sends the DocsAutomator JSON shown below. To start a Claude routine or a ChatGPT agent instead, see Start a Claude or ChatGPT Agent.

Additional Parameters via API

The system supports sending supplementary data alongside webhook notifications through the webhookParams object in API requests.

{
  "docId": "your-automation-id",
  "data": {
    "customer_name": "Acme Corp"
  },
  "webhookParams": {
    "orderId": "ORD-12345",
    "customerId": "CUST-789"
  }
}

These parameters appear in the webhook payload sent to your endpoint under two keys with identical content: webhookParams (matching the request parameter name) and additionalParams (the original key, kept for backward compatibility). Use whichever you prefer — existing integrations built on additionalParams keep working unchanged.

Webhook Payload Structure

{
  "event": "document.created",
  "pdfUrl": "https://...",
  "googleDocUrl": "https://docs.google.com/document/d/...",
  "documentName": "Invoice #123",
  "status": "completed",
  "webhookParams": {
    "orderId": "ORD-12345",
    "customerId": "CUST-789",
    "recId": "recAbC123XyZ"
  },
  "additionalParams": {
    "orderId": "ORD-12345",
    "customerId": "CUST-789",
    "recId": "recAbC123XyZ"
  }
}

Webhook Events

Every webhook names its event in the event field. Use it to tell the events apart, because one webhook URL receives all of them.

Event	When it fires
`document.created`	A document was generated. With Approvals on, it fires after the approval.
`document.approval_rejected`	An approver rejected a held document. Nothing was delivered.
`esign.*`	Signing and acceptance events. See the e-sign webhook events.

The document.created payload is shown above. A document released after an approval also carries an approval object. The document.approval_rejected payload:

{
  "event": "document.approval_rejected",
  "status": "approval_rejected",
  "logId": "unique-run-identifier",
  "documentName": "Invoice #123",
  "approval": {
    "status": "rejected",
    "rule": "all",
    "requestedAt": "ISO date string",
    "requestedBy": { "email": "jonas@example.com", "name": "Jonas Weber" },
    "decidedAt": "ISO date string",
    "decidedBy": { "email": "priya@example.com", "name": "Priya Nair", "forApprover": null },
    "reason": "Wrong amount, please check the quantity.",
    "approvers": [
      { "email": "priya@example.com", "name": "Priya Nair", "decision": "rejected", "decidedAt": "ISO date string" }
    ]
  }
}

Trigger Record Identifier

The identifier of the record that triggered the generation is included automatically, so you can match webhook notifications to records in your data source:

Airtable, SmartSuite, Notion: recId (Notion pageId and button triggers are normalized to recId)
ClickUp: taskId
Google Sheets: rowNumber — positional at trigger time, so treat it as “which row triggered this” rather than a durable key

Your own webhookParams keys are never overwritten by the automatic identifier.

Use Cases

CRM Updates

Update customer records when documents are generated

Workflow Triggers

Trigger downstream automation workflows

Logging

Log document generation events to external systems

Notifications

Send alerts to team collaboration tools

Getting Started

Integrations

Features

Use Cases

Account & Billing

Resources

Purpose

Configuration

Webhook URL Registration

Headers

Additional Parameters via API

Webhook Payload Structure

Webhook Events

Trigger Record Identifier

Use Cases

CRM Updates

Workflow Triggers

Logging

Notifications

​Purpose

​Configuration

​Webhook URL Registration

​Headers

​Additional Parameters via API

​Webhook Payload Structure

​Webhook Events

​Trigger Record Identifier

​Use Cases

CRM Updates

Workflow Triggers

Logging

Notifications

Purpose

Configuration

Webhook URL Registration

Headers

Additional Parameters via API

Webhook Payload Structure

Webhook Events

Trigger Record Identifier

Use Cases