WebhookChain / Documentation

Documentation

Everything you need to use WebhookChain and the forwarding CLI.

Quick Start

1. Create an endpoint

curl -X POST https://webhookchain.com/api/endpoints \
-H "Content-Type: application/json" \
-d '{"label":"my-app"}'

2. Send a test request

curl -X POST https://webhookchain.com/r/<token> \
-H "Content-Type: application/json" \
-d '{"event":"payment.success"}'

3. Inspect in browser

open https://webhookchain.com/wh/<token>

CLI Forwarding Tool

Forward incoming webhook requests to your local development server in real time.

Install

$ npm install -g webhookchain
# or use without installing:
$ npx webhookchain

Create an endpoint via CLI

$ webhookchain create --label my-app

Forward to localhost

$ webhookchain forward --token <token> --to http://localhost:3000

The CLI opens an SSE connection to WebhookChain and re-sends every incoming request to your local URL.

All options

Flag Default Description
--token, -t required Your endpoint token
--to required Local URL to forward requests to
--verbose, -v false Show response bodies in output

REST API

POST
/api/endpoints

Create a new endpoint

{ "label": "string", "expiry": 3600 }
GET
/api/endpoints/:token

Get endpoint details

PATCH
/api/endpoints/:token

Update endpoint settings (response, forwarding)

DELETE
/api/endpoints/:token

Delete endpoint

DELETE
/api/endpoints/:token/requests

Clear all requests

GET
/api/events/:token

SSE stream for live updates (text/event-stream)

*
/r/:token

Webhook receiver — accepts any HTTP method