Create Automation
create-automationCreate a when/filter/then rule that posts reader events to a webhook. The automation starts out active.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Human-readable name for the automation. | |
| scope | No | Which documents to watch. Defaults to "all". | |
| events | Yes | Reader events that trigger the automation, matched with OR. Pass "*" as the only entry to trigger on every event. | |
| doc_ids | No | Public ids of the documents to watch. Required when "scope" is "specific", ignored otherwise. | |
| conditions | No | Filters that must all pass before the webhook fires. Not available for an "*" automation. | |
| webhook_url | Yes | URL that receives the POST request when the automation fires. | |
| webhook_headers | No | Additional headers for the webhook request, as header name => value. |