Get Started with HookTunnel

Follow these steps to set up webhook tunneling for your development environment. Get persistent URLs, offline queueing, and real-time forwarding in minutes.

1
Create Account & API Key
Sign up for HookTunnel and generate your API key

First, create your account and generate an API key to authenticate with the CLI.

Login

Once logged in, go to Dashboard → API Keys to create your key.

2
Install CLI Package
Install the HookTunnel CLI tool globally

Install the CLI package using bun package manager.

bun install -g @hooktunnel/tsuu
3
Authenticate CLI
Login to the CLI with your API key

Authenticate the CLI with your API key.

tsuu login

When prompted, enter your API key from step 1.

4
Explore CLI Commands
View available commands and options

Get help with all available CLI commands and their options.

tsuu help
5
Create Endpoint
Create a webhook endpoint in your dashboard

Create a new webhook endpoint in your dashboard to receive webhooks.

Create Endpoint

This will give you a unique URL to use as your webhook endpoint.

6
Configure Webhook
Use the endpoint URL in your webhook configuration

Copy your endpoint URL and use it in your webhook configuration (Stripe, GitHub, etc.).

Your endpoint URL will look like: https://api.hooktunnel.dev/api/r/your-user-id/your-endpoint-slug

7
Start Local Server
Connect your local development server

Start the tunnel to forward webhooks to your local development server.

tsuu connect -p 3000

Replace 3000 with your local server port. Use tsuu help to see all available options.