> ## Documentation Index
> Fetch the complete documentation index at: https://docsautomator.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Notify Webhook

> Send notifications to external services when documents are generated

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.

<Steps>
  <Step title="Open Output Settings">
    Navigate to your automation's output configuration
  </Step>

  <Step title="Enable Webhook">
    Enable the "Notify Webhook" option
  </Step>

  <Step title="Enter URL">
    Enter your webhook endpoint URL
  </Step>

  <Step title="Test">
    Generate a preview document to test the webhook
  </Step>
</Steps>

## Additional Parameters via API

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

```json theme={null}
{
  "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

```json theme={null}
{
  "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"
  }
}
```

## Trigger Record Identifier

<Info>
  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.
</Info>

## Use Cases

<CardGroup cols={2}>
  <Card title="CRM Updates" icon="users">
    Update customer records when documents are generated
  </Card>

  <Card title="Workflow Triggers" icon="bolt">
    Trigger downstream automation workflows
  </Card>

  <Card title="Logging" icon="clipboard-list">
    Log document generation events to external systems
  </Card>

  <Card title="Notifications" icon="bell">
    Send alerts to team collaboration tools
  </Card>
</CardGroup>