Local Development with ngrok

During development, use ngrok to expose your localhost to the internet so the platform can send webhooks to your local machine.

Install & Run ngrok

1Install ngrok

Terminal
bash
# macOS (Homebrew)
brew install ngrok

# Windows (Chocolatey)
choco install ngrok

# Or download from https://ngrok.com/download

2Start your agent and tunnel

Terminal
bash
# Terminal 1: Start your agent
uvicorn agent:app --port 5001

# Terminal 2: Create a tunnel
ngrok http 5001

3Use the ngrok URL

https://a1b2c3d4.ngrok-free.app/webhook

ngrok URLs are temporary

Free ngrok URLs change on restart. For stable URLs, consider ngrok paid tiers or deploy to a cloud provider.