Notification
Category: Processing
The Notification activity sends a webhook to an external endpoint, typically to announce that a transaction reached a milestone (for example, exported or ready for review) and to provide download links.
Configuration
| Setting | Description | Default |
|---|---|---|
| Webhook URL | Public endpoint that receives the request. | (required) |
| Triggers | When to fire: reached (execution reaches this node) and failed (the workflow aborts before it). Both are on by default, so a transaction that fails still tells you. | reached + failed |
| Event Name | The event value in the payload of a reached notification (for example transaction.exported). | transaction.step_reached |
| HTTP Method | POST or PUT. | POST |
| Secret | If set, the body is signed with HMAC-SHA256 and sent as X-DocAI-Signature: sha256=.... | (none) |
| Timeout | Seconds to wait for the receiver to respond. | 15 |
| Retry Attempts | How many times a failed delivery is retried. | 3 |
| Retry Backoff | Base delay in seconds between retries; it doubles each attempt. | 2 |
| API Base URL | Overrides the host used to build the download links in the payload. Set it when the receiver reaches this deployment on a different address than the one it advertises. | (deployment default) |
| Fail on error | A failed delivery fails the workflow step. | Off |
| Send from test runs | Test runs on the draft (in the Playground, an evaluation or Memory) call the webhook too. Turn it off when the URL is the system your production work goes to and test results should not reach it: only production transactions then call it, and a test run's Activity Log says the webhook was not sent. | On |
Notes
- With Send from test runs on, trying a draft posts test results to the same URL production will use. When you publish, the dialog lists the Notification steps where it is on, so you can turn it off before production starts.
- The webhook host must resolve to a public address.
- See the API webhooks reference for payload details.