Create and Manage Alerts
This is the primary configuration guide for Alerting. It walks through building an alert in the Developer Portal, the same places the left nav lists under Alerting.
Three portal areas: Notification channels, Alert configurations, then Alert logs. Field meanings: Concepts.
Configuration flow at a glance
Recommended order
- Create at least one notification channel.
- Create an alert configuration and attach that channel.
- Leave the rule Enabled.
- Watch Alert logs when something fires.
- Acknowledge or Resolve logs as your team handles them.
Portal areas
| # | Area | Purpose | Nav path |
|---|---|---|---|
| 1 | Notification channels | Email or webhook destinations | Alerting / Notification channels |
| 2 | Alert configurations | Monitoring rules | Alerting / Alert configurations |
| 3 | Alert logs | History of firings + triage | Alerting / Alert logs |
Step 1: Create a notification channel
Give the channel a clear name your team will recognize.
Choose Email or Webhook (see tabs below).
Save: you can reuse this channel on many alert rules.
- Email channel
- Webhook channel
- Choose Email.
- Add one or more recipient addresses.
- Save.
- Choose Webhook.
- Add one or more destination URLs that can receive alert payloads.
- Save.
The alert configuration form asks you to attach a channel. Create at least one email or webhook channel before you start a new alert configuration.
Step 2: Create an alert configuration
Open Alerting / Alert configurations, then create or add a new rule.
Name: something your team will recognize later
Application: the app whose traffic to watch
Category: API or Webhook
Description (optional): why this rule exists
Severity: triage urgency (does not change the math)
Metric: what to measure
Aggregator: how to combine minute values (Maximum, Average, and similar)
Operator + Threshold: comparison and limit
Time window: 15 / 30 / 45 minutes
Write the condition as a plain sentence before you save:
“If the maximum API request count in the last 15 minutes is greater than 1000, warn the team.”
For rate metrics (error rate, success rate, and similar), enter
0.15 for 15%, not 15. See
Concepts: Threshold.
Aggregator Count counts minute samples, not total API calls. For traffic volume prefer Maximum or Average. See Concepts: Aggregator.
Add filters only if you need to narrow traffic (method, endpoint, status, subscription).
Attach one or more channels from Step 1.
Optionally set a subject and short description for the message.
Save and leave the rule Enabled.
Reference: Concepts: Filters.
Start with a single rule and one channel. Confirm you receive a notification and see an alert log, then add more rules or tighter filters.
Example rules you can copy
- Peak API traffic
- Elevated error rate
- Slow responses
| Field | Value |
|---|---|
| Category | API |
| Metric | API request count |
| Combine with | Maximum |
| Operator | Greater than |
| Threshold | 1000 |
| Window | 15 minutes |
| Filter | Methods GET and POST |
| Channel | Ops email |
| Field | Value |
|---|---|
| Category | API |
| Metric | API error rate |
| Combine with | Average |
| Operator | Greater than |
| Threshold | 0.15 (15%) |
| Window | 15 minutes |
| Channel | Ops email |
| Field | Value |
|---|---|
| Category | API |
| Metric | API delivery latency |
| Combine with | Average |
| Operator | Greater than |
| Threshold | 500 (milliseconds) |
| Window | 15 minutes |
| Channel | Ops email or webhook |
Edit, pause, or delete a rule
From Alerting / Alert configurations:
| Action | When to use it |
|---|---|
| Edit | Change threshold, filters, channels, or severity |
| Disable | Temporarily pause monitoring without losing the rule |
| Enable | Resume monitoring |
| Delete | Remove a rule you no longer need |
Manage alert logs
When a rule fires, an entry appears under Alerting / Alert logs.
| Status | Meaning |
|---|---|
| Active | Newly triggered |
| Acknowledged | Someone is handling it |
| Resolved | Closed by your team |
- Open the log entry.
- Update status as your incident process requires.
- Remember: healthy traffic later does not auto-resolve old logs.
More detail on statuses is in the table above. Use the portal Alert logs list to triage firings.
Tips for good alerts
- Prefer rules that map to a real action (page someone, open a ticket, investigate).
- Use filters when one noisy endpoint would otherwise dominate.
- Keep thresholds realistic for your normal traffic.
- Use severity consistently so on-call knows what is urgent.
- Review alert logs after the first few firings and tune the rule.