Skip to content

Commit cf2a3ce

Browse files
committed
Minor updates
1 parent e3cc0f4 commit cf2a3ce

File tree

1 file changed

+40
-17
lines changed

1 file changed

+40
-17
lines changed

fern/observability/monitoring-quickstart.mdx

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ slug: observability/monitoring-quickstart
66

77
## Overview
88

9-
Monitoring lets you automatically track call quality and detect issues across your voice AI agents. Instead of manually reviewing calls, you define monitors that continuously evaluate your call data against thresholds and alert you when something goes wrong.
9+
Monitoring lets you automatically track quality and detect issues across your voice AI agents. Instead of manually reviewing calls, you define monitors that continuously evaluate your call data against thresholds and alert you when something goes wrong.
1010

1111
### What is monitoring?
1212

13-
Monitoring is Vapi's automated quality assurance system for voice AI. You create monitors that periodically evaluate call data using analytics queries (Insights), compare results against thresholds you define, and generate issues when those thresholds are exceeded. Your team receives alerts through email, Slack, or webhooks so you can investigate and resolve problems quickly.
13+
Monitoring is Vapi's automated quality and effectiveness system for voice AI. You create monitors that periodically evaluate call data using analytics queries (Insights), compare results against thresholds you define, and generate issues when those thresholds are exceeded. Your team receives alerts through notifiers, which are alert channels such as email, Slack, or webhooks, so you can investigate and resolve problems quickly.
1414

1515
### Core concepts
1616

1717
- **Monitors** define what to watch, which assistants to target, and when to evaluate
1818
- **Triggers** run on a schedule and evaluate call data against thresholds
19-
- **Issues** are created when thresholds are exceeded, tracking the problem from detection to resolution
20-
- **Alerts** notify you via email, Slack, or webhook when issues arise
19+
- **Issues** are created when a threshold is exceeded and a trigger fires, tracking the problem from detection to resolution
20+
- **Notifiers** are alert channels (email, Slack, or webhook) that deliver notifications to your team when issues are created
2121

2222
### Monitor categories
2323

@@ -46,11 +46,11 @@ In this quickstart, you will create a monitor that tracks error rates across you
4646
</Step>
4747

4848
<Step title="Issues are created">
49-
When a threshold is exceeded, an issue is created with details about the affected calls, the trigger that fired, and the evaluation window.
49+
When a threshold is exceeded and a trigger fires, an issue is created with details about the affected calls, the trigger that fired, and the evaluation window.
5050
</Step>
5151

52-
<Step title="Alerts notify your team">
53-
If alerts are enabled on the trigger, your team receives notifications via email, Slack, or webhook with issue details.
52+
<Step title="Notifiers alert your team">
53+
If notifiers are configured on the trigger, your team receives notifications via email, Slack, or webhook with issue details.
5454
</Step>
5555

5656
<Step title="Investigate and resolve">
@@ -77,7 +77,7 @@ In this quickstart, you will create a monitor that tracks error rates across you
7777

7878
## Step 1: Set up notifiers
7979

80-
Notifiers are alert channels that send notifications when issues are detected. You configure them as credentials in the Dashboard.
80+
Notifiers are alert channels (email, Slack, or webhook) that send notifications when issues are detected. You configure them as credentials in the Dashboard.
8181

8282
<Tabs>
8383
<Tab title="Dashboard">
@@ -146,8 +146,8 @@ Define a monitor that tracks error rates and alerts you when errors exceed a thr
146146
4. Set **Check frequency** to every **1 hour**
147147
</Step>
148148

149-
<Step title="Enable alerts">
150-
1. Toggle **Alerts** to enabled
149+
<Step title="Enable notifiers">
150+
1. Toggle **Notifiers** to enabled
151151
2. Select one or more notifiers from the dropdown
152152
3. Click **Save Monitor**
153153
</Step>
@@ -234,9 +234,20 @@ Save the returned `id` for referencing this monitor later.
234234
create the Insight first and reference its ID here.
235235
</Note>
236236

237-
### Targeting specific assistants
237+
### Managing monitors
238238

239-
To monitor specific assistants instead of all assistants, use the `targets` array:
239+
View, edit, and delete all your monitors from the **Monitors** page in the Dashboard sidebar (under Observe).
240+
241+
Via the API:
242+
- `GET /monitoring/monitor` — list all monitors
243+
- `PATCH /monitoring/monitor/:id` — update a monitor's targets, triggers, or thresholds
244+
- `DELETE /monitoring/monitor/:id` — remove a monitor
245+
246+
### Targeting assistants
247+
248+
Setting `"targets": "*"` monitors **all current and future assistants** in your organization. Any assistant created after the monitor is set up is automatically included.
249+
250+
To monitor only specific assistants, pass an array of assistant IDs using the `targets` array. The `id` field is the assistant ID — the UUID you see in the Dashboard or get from `GET /assistant`.
240251

241252
```json title="Specific assistant targets"
242253
{
@@ -278,7 +289,7 @@ This trigger evaluates at 9:00 AM and 5:00 PM on weekdays.
278289

279290
## Step 3: View issues
280291

281-
When a trigger fires and the threshold is exceeded, an issue is created. You can view and manage issues in the Dashboard or via the API.
292+
When a threshold is exceeded and a trigger fires, an issue is created. You can view and manage issues in the Dashboard or via the API.
282293

283294
<Tabs>
284295
<Tab title="Dashboard">
@@ -466,9 +477,21 @@ curl -X POST "https://api.vapi.ai/monitoring/issue/e5f6a7b8-c9d0-1234-efab-56789
466477
return the cached result immediately.
467478
</Note>
468479

480+
<Tip>
481+
Use the `callId` values from the issue's `calls` array to review specific call
482+
logs and recordings for deeper investigation. Each call ID links directly to the
483+
call details in your Dashboard.
484+
</Tip>
485+
469486
## Step 5: Resolve an issue
470487

471-
After investigating and fixing the underlying problem, acknowledge and resolve the issue to track your team's response.
488+
After investigating and fixing the underlying problem, acknowledge and resolve the issue to track your team's response. Resolve an issue once you've deployed a fix and confirmed the problem no longer recurs — this signals to your team that the root cause has been addressed. Acknowledgment and resolution timestamps help measure your team's incident response times.
489+
490+
<Note>
491+
Issues are a single shared resource. Status changes made in the Dashboard are
492+
immediately reflected in API responses, and vice versa. Your team can freely use
493+
both without conflicts.
494+
</Note>
472495

473496
<Tabs>
474497
<Tab title="Dashboard">
@@ -557,15 +580,15 @@ curl -X PATCH "https://api.vapi.ai/monitoring/issue/e5f6a7b8-c9d0-1234-efab-5678
557580
| Issue | Solution |
558581
| --- | --- |
559582
| No issues are being created | Verify monitor status is "active". Check that the trigger interval and threshold are configured correctly. Ensure your assistants have recent call data. |
560-
| Alerts not received | Confirm alert status is "enabled" on the trigger. Verify credential IDs reference valid notifiers. Check the notifier configuration (email address, webhook URL, Slack webhook). |
583+
| Alerts not received | Confirm notifiers are enabled on the trigger. Verify credential IDs reference valid notifiers. Check the notifier configuration (email address, webhook URL, Slack webhook). |
561584
| Analysis returns an error | Ensure the issue has associated calls. Analysis requires call data to identify patterns. |
562585
| Monitor not evaluating | Check that the `insightId` references a valid Insight. Verify the trigger interval is at least 1 minute. |
563586
| Wrong calls detected | Review the Insight query that the trigger references. Ensure the monitor targets the correct assistants. |
564587
| Duplicate issues | Triggers create new issues per evaluation window. This is expected behavior when a problem persists across multiple evaluation periods. |
565588

566589
<Warning>
567-
If alerts show a `"failure"` status in the issue's alerts array, the
568-
notification delivery failed. Check your notifier credentials and ensure the
590+
If an alert shows a `"failure"` status in the issue's alerts array, the
591+
notification delivery failed. Check your notifier configuration and ensure the
569592
destination (email, Slack webhook, URL) is reachable.
570593
</Warning>
571594

0 commit comments

Comments
 (0)