Documentation
Webhook Tunnel Quickstart
Install Kite and stream your first webhook in under two minutes.
Get Kite running and stream your first webhook in under two minutes.
1. Install the CLI
bash
curl -fsSL https://getkite.sh/install | sh
This installs kite to writable /usr/local/bin, or falls back to ~/.local/bin. See Installation for supported targets, Homebrew, and direct downloads.
2. Log in
bash
kite login
This opens your browser for device auth. Once approved, your API key is stored locally at ~/.config/kite/config.toml.
3. Create a webhook endpoint
bash
kite endpoints create --source github
Kite returns a webhook URL and a one-time signing secret. Add these to your GitHub repository settings under Settings → Webhooks.
4. Stream events
bash
kite stream --source github
Push a commit or open a pull request. You'll see CloudEvent payloads arrive in real time:
code
[com.github.push] refs/heads/main — 1 commit(s) by alice [com.github.pull_request.opened] PR #42 by alice — "Add quickstart guide"
5. Proxy to a local server (optional)
If you have a local HTTP server, use kite proxy to forward events directly:
bash
kite proxy --source github --target http://localhost:3000/webhooks
Next steps
- Concepts: CloudEvents — understand the event envelope
- CLI Reference — full command options
- Guides: GitHub Webhooks — a detailed walkthrough
- Guides: Emitting Events — send events from your own app with the SDK