@webhookhq/whq-cli
v1.1.0
Published
WebhookHQ CLI — tunnel webhooks to localhost
Downloads
129
Maintainers
Readme
whq — WebhookHQ CLI
Tunnel webhooks from WebhookHQ to your localhost for development and debugging.
Install
npm install -g @webhookhq/whq-cliRequires Node.js 18+.
Quick Start
# 1. Log in
whq login
# 2. Start listening — forwards webhooks to localhost:3000
whq listen 3000Commands
whq login
Log in with your WebhookHQ email and password. Your API token is fetched automatically and saved to ~/.whq/config.json.
whq logout
Remove your stored credentials.
whq listen <port>
Connect to WebhookHQ and forward incoming webhooks to http://localhost:<port>.
whq listen 3000 # auto-selects endpoint
whq listen 3000 --endpoint my-app # use a specific endpointPress r to replay the last received event. Press Ctrl+C to quit.
whq endpoints
List all your webhook endpoints, including protocol and active status.
whq events
List recent events across all endpoints.
whq events # last 50 events
whq events --endpoint my-app # filter by endpoint
whq events --protocol mqtt # filter by protocol (http, mqtt)
whq events --limit 100 # return up to 100 eventswhq replay <id> --port <port>
Replay a specific webhook event to localhost.
whq replay evt_abc123 --port 3000whq authtoken <token>
Save an API token directly, without logging in interactively. Tokens start with whq_ and can be generated from your dashboard.
Options
| Flag | Description |
| --- | --- |
| --server <url> | Override the server URL (default: https://app.webhookhq.dev) |
| --endpoint <slug> | Select a specific endpoint (for listen and events) |
| --protocol <proto> | Filter by protocol: http, mqtt (for events) |
| --limit <n> | Max number of results to return (for events) |
| --help | Show help |
| --version | Show version |
Configuration
Config is stored in ~/.whq/config.json with restricted file permissions (0600).
License
MIT
