Skip to content

Clarify vapi listen documentation #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2025

Conversation

goosewin
Copy link
Collaborator

@goosewin goosewin commented Jul 8, 2025

Description

  • Clarified that vapi listen is a local forwarder only and does not provide an external proxy, tunnel, or public URL.
  • Updated documentation across multiple files to explicitly state the requirement for a separate tunneling service (e.g., ngrok) when using vapi listen.
  • Removed misleading references to automatic public URLs and webhook-proxy.vapi.ai.
  • Revised examples and instructions to include steps for setting up and using tunneling services.

Testing Steps

  • Run the app locally using fern docs dev or navigate to preview deployment
  • Ensure that the changed pages and code snippets work, specifically:
    • /cli/webhook-testing
    • /server-url/developing-locally
    • /server-url
    • /cli/overview
    • /debugging
    • /tools/custom-tools
    • /cli/mcp-integration

@goosewin goosewin self-assigned this Jul 8, 2025
Copy link
Contributor

github-actions bot commented Jul 8, 2025

@nitishsurana nitishsurana merged commit 8935346 into main Jul 8, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants