HooksDash
Get Started

CLI Documentation

Forward webhooks to your local development server

The HooksDash CLI allows you to forward webhooks from HooksDash to your local development server in real-time.

Quick Start

# Install globally
npm install -g hooksdash

# Login
hooksdash login

# Forward webhooks to your local server
hooksdash forward --port 3000

What is the CLI?

The HooksDash CLI creates a secure tunnel between HooksDash and your local machine, forwarding incoming webhooks to your development server. This allows you to:

  • Test webhooks locally without deploying to production
  • Debug webhook handlers with your favorite development tools
  • Develop webhook integrations with live data from services like Stripe, GitHub, Twilio, etc.
  • Inspect webhook payloads in your local application

How It Works

┌────────────────┐        ┌──────────────┐        ┌─────────────┐
│  Webhook       │        │  HooksDash   │        │  Your Local │
│  Provider      ├───────►│  Platform    ├───────►│  Server     │
│  (Stripe, etc) │  HTTPS │              │ Tunnel │  :3000      │
└────────────────┘        └──────────────┘        └─────────────┘
  1. Webhook provider (e.g., Stripe) sends a webhook to your HooksDash endpoint
  2. HooksDash receives and stores the webhook
  3. The CLI forwards the webhook to your local server via WebSocket tunnel
  4. Your local application processes the webhook

Features

  • Real-time forwarding: Webhooks are forwarded instantly via WebSocket
  • Automatic reconnection: Handles network interruptions gracefully
  • Multiple endpoints: Forward different endpoints to different local ports
  • HTTPS to HTTP: Receive HTTPS webhooks on your HTTP local server
  • No port forwarding required: Works behind firewalls and NAT
  • Browser authentication: Secure OAuth-like login flow

Documentation

Common Use Cases

Stripe Webhook Development

# Forward Stripe webhooks to your local server
hooksdash forward --port 3000 --endpoint stripe-dev

# In your Stripe dashboard, configure:
# https://hooksdash.ibadsiddiqui.dev/api/h/stripe-dev

GitHub Webhook Testing

# Forward GitHub webhooks
hooksdash forward --port 4000 --endpoint github-dev

# In your GitHub repo settings, add webhook:
# https://hooksdash.ibadsiddiqui.dev/api/h/github-dev

Multiple Services

# Terminal 1: Forward Stripe webhooks
hooksdash forward --port 3000 --endpoint stripe-dev

# Terminal 2: Forward GitHub webhooks
hooksdash forward --port 4000 --endpoint github-dev

Requirements

  • Node.js 18 or higher
  • npm 9 or higher
  • Active HooksDash account

Support