Skip to main content

Documentation Index

Fetch the complete documentation index at: https://documentation.uponai.com/llms.txt

Use this file to discover all available pages before exploring further.

Alerting monitors your voice AI operations by sending automatic email or webhook notifications when specific metrics cross defined thresholds — no manual dashboard checking required.

​
Use Cases

  • Monitor call volume spikes or unexpected drops
  • Track API errors or function failures
  • Set budget alerts when call costs exceed thresholds
  • Detect declining call success rates or negative sentiment

​
Available Metrics

MetricDescription
Call CountTotal calls within the evaluation window
Concurrency UsedPeak concurrent calls
Call Success RatePercentage of successful calls (0–100%)
Negative Sentiment RatePercentage of calls with negative sentiment (0–100%)
Custom Function LatencyAverage latency of custom function calls (ms)
Custom Function Failure CountNumber of failed custom function calls
Transfer Call Failure CountNumber of failed call transfers
Total Call CostTotal cost of calls (USD)
API Error CountNumber of API errors (filterable by error code)

​
Creating an Alert Rule

Navigate to the Alerting tab in the dashboard. Each rule requires:
FieldDescription
NameDescriptive name for the alert
MetricThe metric to monitor
Threshold typeAbsolute or relative
Threshold valueValue to compare against
ComparatorGreater than, less than, etc.
Evaluation windowTime period for metric aggregation
FrequencyHow often to evaluate the rule
Notification channelsEmail addresses and/or webhook URLs

​
Threshold Types

Absolute — Compares current metric value directly against your threshold.
Example: Alert when Call Count > 100 in the last hour.
Relative — Compares percentage change from the previous period. Useful for detecting sudden spikes or drops.
Example: Alert when Call Count increases by more than 50% compared to the previous hour.
Formula: ((currentValue - previousValue) / previousValue) * 100
If the previous period had zero calls but the current period has calls, this is treated as an infinite increase and will trigger alerts with > or >= comparators.

​
Evaluation Windows and Frequencies

WindowSupported Frequencies
1 minute1 minute
5 minutes1 minute, 5 minutes
30 minutes5 minutes, 30 minutes
1 hour5 minutes, 30 minutes, 1 hour
12 hours30 minutes, 1 hour, 12 hours
24 hours1 hour, 12 hours, 24 hours
3 days12 hours, 24 hours
7 days24 hours

​
Filters

  • Agent Filter — Filter by specific agents and optionally by agent versions
  • Disconnection Reason Filter — Filter by disconnection reason (e.g. user_hangup, agent_hangup)
  • Error Code Filter — For API Error Count, filter by specific HTTP status codes (e.g. 429, 402)

​
Notification Channels

​
Email

All configured recipients receive an email containing: alert rule name, metric type, current value, threshold breached, and timestamp.

​
Webhook

Configure webhook URLs to receive programmatic notifications — integrates with Slack, PagerDuty, or custom workflows. Webhook payload: 
{
  "event": "alert_triggered",
  "alert": {
    "alert_incident_id": "abc123def456...",
    "alert_rule_id": "alert_rule_xyz789...",
    "name": "High Call Volume Alert",
    "metric_type": "call_count",
    "threshold_type": "absolute",
    "threshold_value": 100,
    "comparator": ">",
    "frequency": "1h",
    "window": "1h",
    "current_value": 150,
    "triggered_timestamp": 1714608475945
  }
}
Verify webhook signatures — all requests include an X-Retell-Signature header with an HMAC-SHA256 signature:
Node
import UponAI from 'uponai-sdk';

const isValid = UponAI.verify(
  JSON.stringify(payload),
  apiKey,
  signature // from X-Retell-Signature header
);
Always verify webhook signatures in production to ensure requests originate from UponAI.

​
Alert Incidents

When an alert rule’s condition is met, an incident is created tracking:
  • When the alert was triggered
  • The metric value that triggered it
  • When the alert resolved (if applicable)
Incident lifecycle:
  1. Triggered — Metric breaches threshold; incident created, notifications sent
  2. Active — Incident remains active while condition persists
  3. Resolved — Metric no longer breaches threshold; incident marked resolved
Only one incident can be active per alert rule at a time. Notifications are sent only when a new incident is created, not on every evaluation.

​
Limits

  • Maximum 10 alert rules per organization
  • Webhook timeout: 10 seconds