Create Alert
create-alertCreate a scheduled GNQL query alert that notifies recipients via email or webhook when matching data is detected.
Instructions
Create a scheduled alert that runs a GNQL query and notifies recipients (email/webhook) when it matches. Requires a plan entitled to alerts.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Alert name | |
| query | Yes | GNQL query the alert monitors | |
| enabled | No | Whether the alert is active (default: true) | |
| schedule | Yes | When the alert query runs and notifies | |
| recipients | Yes | Where to send alert notifications | |
| workspace_id | No | Workspace ID (UUID). Defaults to the workspace the API key is bound to. | |
| query_workspace_id | No | Workspace to run the query against, if different |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | No | ||
| type | No | ||
| status | No | ||
| enabled | No | ||
| schedule | No | ||
| created_at | No | ||
| gnql_query | No | ||
| parameters | No | ||
| recipients | No | ||
| updated_at | No | ||
| workspace_id | No | ||
| query_workspace_id | No |