Overview

Fast local webhook capture, storage, inspection, and replay from one CLI.

wsignal is a lightweight local webhook receiver for development workflows. It runs a local HTTP server, matches requests against named endpoints, persists every matched request as JSONL, and gives you tools to inspect and replay captured traffic.

What It Does

• Receives webhook requests on localhost.
• Supports multiple named endpoints from one config file.
• Persists matched requests before acknowledging them.
• Rotates log files by size.
• Browses saved events from the terminal.
• Replays captured events to another URL.
• Optionally forwards events to one or more targets after local persistence.

Core Workflow

1. Create a config with wsignal init or by writing wsignal.config.ts yourself.
2. Start the receiver with wsignal dev.
3. Send requests to one or more configured endpoints.
4. Review saved events with wsignal logs or wsignal inspect.
5. Replay a captured request with wsignal replay.

Default Behavior

• Default config file: wsignal.config.ts
• Alternate config files: wsignal.config.js, wsignal.config.mjs
• Default port: 8787
• Default storage directory: .wsignal
• Default central log file: events.jsonl
• Default rotation policy: 10 MB, keep 20 rotated files
• Default endpoint method: POST
• Default endpoint response: 200 text/plain with an empty body

When To Use It

wsignal fits local development cases where you want to:

• Receive webhook traffic without exposing a full application route first.
• Capture payloads for debugging and replay.
• Split incoming traffic by endpoint or log file.
• Keep a simple audit trail of webhook activity during development.

Next Steps

• Start with Installation.
• Follow the Quickstart.
• Read the Configuration Overview before setting up multiple endpoints.