Webhook Forwarding
Forward webhooks from HookWatch to your local development server in real-time. The CLI connects via gRPC streaming to receive webhooks instantly as they arrive.
Basic Usage
Forward webhooks from an endpoint to your local server:
By default, webhooks are forwarded to http://localhost:3000.
Authentication
If you haven't logged in, pass your API key:
Get your API key from the API Keys page in your dashboard.
Options
| Flag | Environment Variable | Default | Description |
|---|---|---|---|
| --api-key | HOOKWATCH_API_KEY | - | API key for authentication |
| --forward | FORWARD_URL | http://localhost:3000 | URL to forward webhooks to |
| --server | HOOKWATCH_SERVER | api.hookwatch.dev:9090 | HookWatch gRPC server address |
| -v, --verbose | - | false | Enable verbose output |
| --no-color | - | false | Disable colored output |
| --json | - | false | Output events as JSON (one per line) |
| --insecure | GRPC_INSECURE | false | Use insecure connection (no TLS) |
Examples
Forward multiple endpoints
Listen to multiple endpoints simultaneously:
Forward to a different port
Send webhooks to a custom URL:
JSON output for scripting
Pipe JSON output to other tools:
Verbose output for debugging
See detailed connection and request information:
How it works
- The CLI connects to HookWatch via gRPC streaming
- Subscribes to the specified endpoint slugs
- Receives webhooks in real-time as they arrive at HookWatch
- Forwards each webhook to your local server
- Reports delivery status back to HookWatch
Real-time streaming
Unlike polling-based solutions, the CLI uses gRPC bidirectional streaming for instant webhook delivery with minimal latency.
Troubleshooting
Connection refused
Make sure your local server is running and listening on the correct port.
Authentication failed
Verify your API key is correct. Run hookwatch login to
re-authenticate.
No webhooks received
Ensure the endpoint slug is correct and the endpoint exists in your account.
Timeouts
Check your firewall settings. The CLI needs to connect to api.hookwatch.dev:9090.