Quickstart

​

Quick Start Steps

# Using Homebrew
brew install unhook

# Using npm
npm install -g @unhook/cli

# Using yarn
yarn global add @unhook/cli

# Using pnpm
pnpm add -g @unhook/cli

# Using bun
bun add -g @unhook/cli

# Using deno
deno install @unhook/cli

# Using npx
npx @unhook/cli init

# Using bunx
bunx @unhook/cli init

# Using pnpm
pnpm dlx @unhook/cli init

# Using deno
deno run --allow-net --allow-read --allow-write npm:@unhook/cli init

# Basic usage
unhook listen

# With custom client ID
unhook listen --client-id your-name

# With debug logging
unhook listen --debug

https://unhook.sh/wh_your_webhook_id

​

Configuration

​

Basic Configuration

Create an unhook.yaml file in your project root:

webhookId: "wh_your_webhook_id"
debug: false
telemetry: true
destination:
  - name: "your-endpoint"
    url: "http://localhost:3000/api/webhooks"
source:
  - name: "stripe"
  - name: "github"
delivery:
  - source: "stripe"
    destination: "your-endpoint"
  - source: "github"
    destination: "your-endpoint"

​

Environment Variables

Configure via environment variables:

# Core settings
WEBHOOK_PORT=3000
WEBHOOK_API_KEY=your_api_key
WEBHOOK_CLIENT_ID=dev-1
WEBHOOK_DEBUG=true

# Advanced settings
WEBHOOK_REDIRECT=https://api.example.com
WEBHOOK_PING=true

​

Provider Setup

​

Stripe

1. Go to your Stripe Dashboard
2. Click “Add Endpoint”
3. Enter your Unhook URL:

https://unhook.sh/wh_your_webhook_id

​

GitHub

1. Go to your repository settings
2. Navigate to “Webhooks”
3. Click “Add webhook”
4. Enter your Unhook URL:

https://unhook.sh/wh_your_webhook_id

​

Clerk

1. Go to your Clerk Dashboard
2. Navigate to “Webhooks”
3. Click “Add Endpoint”
4. Enter your Unhook URL:

https://unhook.sh/wh_your_webhook_id

​

Team Development

​

Shared Configuration

Teams can share a single webhook configuration:

webhookId: "wh_team_webhook_id"
destination:
  - name: "dev1"
    url: "http://localhost:3000/api/webhooks"
    ping: true
  - name: "dev2"
    url: "http://localhost:3001/api/webhooks"
    ping: true
source:
  - name: "clerk"
  - name: "stripe"
delivery:
  - source: "clerk"
    destination: "dev1"
  - source: "stripe"
    destination: "dev2"

​

Team Features

• Shared Webhook URL: All team members use the same webhook URL
• Individual Routing: Each developer can receive specific webhook types
• Request History: View and replay requests across the team
• Real-time Monitoring: See incoming requests in real-time
• Team Dashboard: Monitor team activity and webhook status

​

Security Features

• API key authentication for private webhooks
• Method restrictions
• Source restrictions
• Request body size limits
• Header filtering
• End-to-end encryption

​

Authentication

Authentication data is stored locally at ~/.unhook/auth-storage.json:

• Authentication state
• User tokens
• Organization ID
• Basic user info

To clear auth data:

rm ~/.unhook/auth-storage.json

​

Next Steps

​

Support

• Documentation
• GitHub Issues
• Discord Community