Alert rules let you define conditions that trigger notifications when your pipes cross a threshold. Use them to stay informed about failure spikes, callback issues, or unexpected credit consumption.Documentation Index
Fetch the complete documentation index at: https://docs.docpipe.ai/llms.txt
Use this file to discover all available pages before exploring further.
Creating a rule
- Go to Settings → Alert rules
- Click New Alert Rule
- Configure the rule (see below)
- Click Create Alert Rule
Rule configuration
| Field | Description |
|---|---|
| Name | A descriptive name for the rule |
| Metric | The metric to monitor (see available metrics) |
| Operator | Comparison operator: Greater Than or Less Than |
| Threshold | The value that triggers the alert |
| Scope | Optional. Limit the rule to a specific pipe, or leave blank to apply across all pipes |
| Channel | How you want to be notified: In-App or Email |
| Email recipients | Required when channel is Email. One or more email addresses |
| Enabled | Toggle the rule on or off |
Available metrics
| Metric | Description | Threshold range |
|---|---|---|
| Failure Rate | Proportion of runs that failed in the past hour | 0–1 (e.g., 0.1 = 10%) |
| Callback Failure Rate | Proportion of callback deliveries that failed in the past hour | 0–1 |
| Credit Burn Rate | Credits consumed per day | Credits/day |
| Credit Balance | Remaining credits on your organization’s plan | Credits |
Credit Balance is an organization-wide metric. Pair it with the Less Than operator to get notified when your remaining credits drop below a threshold so you can top up before runs start failing.
Notification channels
- In-App: alerts appear in real time via the notification area in the app
- Email: alerts are sent to the specified email recipients
Pipe scope
By default, a rule evaluates metrics across all pipes. To monitor a specific pipe, select it in the Scope field when creating or editing the rule. The Credit Balance metric is always organization-wide and cannot be scoped to a pipe.Managing rules
From Settings → Alert rules, you can:- Edit: update any rule configuration
- Enable/disable: toggle a rule without deleting it
- Delete: permanently remove a rule
Real-time evaluation
Alert rules are evaluated continuously. When a threshold is crossed, the notification is delivered immediately through the configured channel.Permissions
Managing alert rules requires a role with Core.AlertRule permissions:| Permission | Description |
|---|---|
Core.AlertRule.Read | View alert rules |
Core.AlertRule.Create | Create new alert rules |
Core.AlertRule.Update | Edit alert rules |
Core.AlertRule.Delete | Delete alert rules |