Skip to content

Commit adf9ae4

Browse files
committed
fix: vapi listen disclaimer
1 parent e67b48d commit adf9ae4

File tree

8 files changed

+72
-26
lines changed

8 files changed

+72
-26
lines changed

fern/cli/overview.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Vapi CLI is the official command-line interface that brings world-class deve
1212
- Install and authenticate with the Vapi CLI
1313
- Initialize Vapi in existing projects
1414
- Manage assistants, phone numbers, and workflows from your terminal
15-
- Test webhooks locally without external tunnels
15+
- Forward webhooks to your local development server
1616
- Turn your IDE into a Vapi expert with MCP integration
1717

1818
## Installation
@@ -94,13 +94,17 @@ Your IDE's AI assistant (Cursor, Windsurf, VSCode) gains complete, accurate know
9494

9595
### 🔗 Local webhook testing
9696

97-
Debug webhooks instantly without ngrok:
97+
Forward webhooks to your local server for debugging:
9898

9999
```bash
100100
vapi listen --forward-to localhost:3000/webhook
101101
```
102102

103-
All webhook events get forwarded to your local server in real-time with helpful debugging information.
103+
The CLI provides a public endpoint that forwards events to your local server. You'll need to update your webhook URLs in Vapi to point to this endpoint.
104+
105+
<Note>
106+
Automatic webhook URL configuration (like Stripe CLI) is coming soon. For now, manually update your webhook URLs in the Vapi dashboard.
107+
</Note>
104108

105109
### 🔐 Multi-account management
106110

fern/cli/webhook-testing.mdx

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,65 @@
11
---
22
title: Local webhook testing
3-
description: Test webhooks locally without ngrok using vapi listen
3+
description: Forward webhooks to your local development server with vapi listen
44
slug: cli/webhook
55
---
66

77
## Overview
88

9-
The `vapi listen` command enables real-time webhook testing on your local development server without external tunneling services like ngrok. This dramatically speeds up development by letting you test webhook integrations instantly.
9+
The `vapi listen` command provides a webhook forwarding service that receives events from Vapi and forwards them to your local development server. This helps you debug webhook integrations without deploying your code.
1010

1111
**In this guide, you'll learn to:**
1212
- Set up local webhook forwarding
1313
- Debug webhook events in real-time
1414
- Configure advanced forwarding options
1515
- Handle different webhook types
1616

17+
<Info>
18+
**Note on tunneling:** Currently, `vapi listen` requires you to manually update your webhook URLs in Vapi. Automatic tunnel creation (like Stripe CLI) is coming in a future update.
19+
</Info>
20+
1721
## Quick start
1822

19-
Forward Vapi webhooks to your local server:
23+
<Steps>
24+
<Step title="Start the webhook listener">
25+
```bash
26+
vapi listen --forward-to localhost:3000/webhook
27+
```
28+
29+
Note the public URL provided in the output (e.g., `https://webhook-proxy.vapi.ai/wh_abc123def456`)
30+
</Step>
31+
32+
<Step title="Update your webhook URLs">
33+
Go to your Vapi Dashboard and update your webhook URLs to point to the URL from step 1:
34+
- Assistant webhook URL
35+
- Phone number webhook URL
36+
- Or any other webhook configuration
37+
</Step>
38+
39+
<Step title="Test your webhooks">
40+
Trigger webhook events (make calls, etc.) and see them forwarded to your local server in real-time
41+
</Step>
42+
</Steps>
2043

21-
```bash
22-
vapi listen --forward-to localhost:3000/webhook
23-
```
44+
## How it works
2445

25-
That's it! All webhook events from Vapi will be forwarded to your local endpoint in real-time.
46+
<Note>
47+
**Current implementation:** The `vapi listen` command currently acts as a local webhook forwarder. Unlike tools like Stripe CLI, it doesn't yet create an automatic tunnel to update your Vapi webhook URLs. You'll need to manually configure your webhook URL in Vapi to point to the CLI's endpoint.
2648

27-
## How it works
49+
**Coming soon:** Automatic tunneling that updates your Vapi webhook configuration is planned for a future release.
50+
</Note>
2851

2952
<Steps>
3053
<Step title="Local server starts">
3154
The CLI starts a webhook server on port 4242 (configurable)
3255
</Step>
3356

34-
<Step title="Secure tunnel created">
35-
A secure tunnel is established between Vapi and your local server
57+
<Step title="Configure webhook URL">
58+
Update your Vapi webhook URL to point to the CLI's public endpoint (provided when you start the listener)
3659
</Step>
3760

3861
<Step title="Events forwarded">
39-
All webhook events are forwarded to your specified endpoint
62+
All webhook events are forwarded to your specified local endpoint
4063
</Step>
4164

4265
<Step title="Real-time logging">
@@ -87,10 +110,11 @@ When you run `vapi listen`, you'll see:
87110
$ vapi listen --forward-to localhost:3000/webhook
88111

89112
🎧 Vapi Webhook Listener
90-
📡 Listening on: https://vapi-webhooks.ngrok.io/abc123
113+
📡 Listening on: https://webhook-proxy.vapi.ai/wh_abc123def456
91114
📍 Forwarding to: http://localhost:3000/webhook
92115

93-
✓ Webhook URL configured in your Vapi account
116+
⚠️ Please update your webhook URL in Vapi to:
117+
https://webhook-proxy.vapi.ai/wh_abc123def456
94118

95119
Waiting for webhook events...
96120

@@ -150,6 +174,18 @@ X-Webhook-Timestamp: 1705331445
150174

151175
Your server receives the exact webhook payload from Vapi with these additional headers for debugging.
152176

177+
### Manual webhook configuration
178+
179+
Since automatic tunneling isn't available yet, you'll need to:
180+
181+
1. Start the webhook listener and note the public URL
182+
2. Go to your Vapi Dashboard or use the API to update webhook URLs
183+
3. Set the webhook URL to the one provided by `vapi listen`
184+
185+
<Tip>
186+
**Future enhancement:** We're working on automatic webhook URL updates, similar to how Stripe CLI works. This will eliminate the manual configuration step.
187+
</Tip>
188+
153189
### Filtering events
154190

155191
Filter specific event types (coming soon):

fern/debugging.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,13 +125,13 @@ Navigate to `Observe > Webhook Logs` to:
125125
<Tip>
126126
**Local webhook debugging with Vapi CLI:**
127127

128-
Test webhooks instantly without deploying:
128+
Forward webhooks to your local server:
129129

130130
```bash
131131
vapi listen --forward-to localhost:3000/webhook
132132
```
133133

134-
This eliminates the need for ngrok and shows real-time event data in your terminal. [Learn more →](/cli/webhook)
134+
The CLI provides a public endpoint that forwards events to your local server. You'll need to update your webhook URLs in Vapi to use this endpoint. Automatic configuration is coming soon. [Learn more →](/cli/webhook)
135135
</Tip>
136136

137137
### Voice Test Suites

fern/quickstart/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ The Vapi CLI brings the full power of the platform to your terminal:
142142
iconType="solid"
143143
>
144144
- **Project Integration:** Auto-detect and set up Vapi in any codebase
145-
- **Local Testing:** Debug webhooks without ngrok
145+
- **Webhook Forwarding:** Test webhooks on your local server
146146
- **MCP Support:** Turn your IDE into a Vapi expert
147147
- **Multi-account:** Switch between environments seamlessly
148148
</Card>

fern/quickstart/web.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Build powerful voice applications that work across web browsers, mobile apps, an
2121
# Initialize Vapi in your project
2222
vapi init
2323

24-
# Test webhooks without ngrok
24+
# Forward webhooks to local server
2525
vapi listen --forward-to localhost:3000/webhook
2626
```
2727

fern/server-url.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ To get started using server URLs, read our guides:
5858
iconType="solid"
5959
href="/cli/webhook"
6060
>
61-
Test webhooks instantly with the Vapi CLI - no ngrok required.
61+
Forward webhooks to your local server with the Vapi CLI.
6262
</Card>
6363
</CardGroup>
6464

fern/server-url/developing-locally.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,23 @@ slug: server-url/developing-locally
1111

1212
## Quick solution: Vapi CLI
1313

14-
The easiest way to test webhooks locally is with the Vapi CLI:
14+
Test webhooks locally with the Vapi CLI webhook forwarder:
1515

1616
```bash
1717
# Install Vapi CLI
1818
curl -sSL https://vapi.ai/install.sh | bash
1919

20-
# Forward webhooks to your local server
20+
# Start webhook forwarding
2121
vapi listen --forward-to localhost:3000/webhook
2222
```
2323

24-
This eliminates the need for ngrok or other tunneling services. [Learn more about the Vapi CLI →](/cli/webhook)
24+
The CLI provides a public endpoint that forwards events to your local server. You'll need to manually update your webhook URLs in Vapi to use this endpoint.
25+
26+
<Note>
27+
Unlike tools like Stripe CLI, automatic webhook URL configuration isn't available yet. This feature is coming in a future update. For now, the CLI works similarly to ngrok - providing a public URL that you configure manually.
28+
</Note>
29+
30+
[Learn more about the Vapi CLI →](/cli/webhook)
2531

2632
## Manual setup with ngrok
2733

fern/tools/custom-tools.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,13 @@ vapi tool delete <tool-id>
106106
```
107107

108108
<Tip>
109-
**Local development tip:** When developing custom tools, use the Vapi CLI to test webhooks locally:
109+
**Local development tip:** When developing custom tools, use the Vapi CLI to forward webhooks to your local server:
110110

111111
```bash
112112
vapi listen --forward-to localhost:3000/tools/webhook
113113
```
114114

115-
This forwards all tool execution requests to your local server for real-time debugging. [Learn more →](/cli/webhook)
115+
The CLI provides a public endpoint that you can configure as your tool's server URL for testing. Automatic URL configuration is coming soon. [Learn more →](/cli/webhook)
116116
</Tip>
117117

118118
## Alternative: API Configuration

0 commit comments

Comments
 (0)