WebHook Tester

This application allows you to test and debug Webhooks and HTTP requests using unique (random) URLs. You can customize the response code, content-type HTTP header, response content and set some delay for the HTTP responses. The main idea is viewed here.

This application is written in GoLang and works very fast. It comes with a tiny UI (written in Vue.js), which you can customize however you want. Websockets are also used for incoming webhook notifications in UI - you don't need any 3rd party solutions (like pusher.com) for this!

🔥 Features list

Customizable front-end, based on vue.js (without the need for a builder/bundler)
Liveness/readiness probes (routes /live and /ready respectively)
Can be started without any 3rd party dependencies
Metrics in prometheus format (route /metrics)
Multi-arch docker image, based on scratch
Unprivileged user in docker image is used
Well-tested and documented source code
Built-in CLI health check sub-command
Recorded request binary view using UI
JSON/human-readable logging formats
Customizable webhook responses
Built-in Websockets support
Low memory/cpu usage
Free and open-source
Ready to scale

Storage

At the moment 2 types of data storage are supported - memory and redis server (flag --storage-driver).

The memory driver is useful for fast local debugging when recorded requests will not be needed after the app stops. The Redis driver, on the contrary, stores all the data on the redis server, and the data will not be lost after the app restarts. When running multiple app instances (behind the load balancer), it is also necessary to use the redis driver.

Pub/sub

Publishing/subscribing are used to send notifications using WebSockets, and it also supports 2 types of driver - memory and redis server (flag --pubsub-driver).

For multiple app instances redis driver must be used.

Installing

Download the latest binary file for your os/arch from the releases page or use our docker image (ghcr.io). Also, you may need in ./web directory content for web UI access.

Usage

This application supports the next sub-commands:

Sub-command	Description
`serve`	Start HTTP server
`healthcheck`	Health checker for the HTTP server (use case - docker healthcheck) (hidden in CLI help)
`version`	Display application version

And global flags:

Flag	Description
`--verbose`, `-v`	Verbose output
`--debug`	Debug output
`--log-json`	Logs in JSON format

HTTP server starting

serve sub-command allows to use next flags:

Flag	Description	Default value	Environment variable
`--listen`, `-l`	IP address to listen on	`0.0.0.0` (all interfaces)	`LISTEN_ADDR`
`--port`, `-p`	TCP port number	`8080`	`LISTEN_PORT`
`--public`	Path to the directory with public assets	`%app_bin%/web`	`PUBLIC_DIR`
`--storage-driver`	Storage engine (`memory` or `redis`)	`memory`	`STORAGE_DRIVER`
`--pubsub-driver`	Pub/Sub engine (`memory` or `redis`)	`memory`	`PUBSUB_DRIVER`
`--redis-dsn`	Redis server DSN (required if storage or pub/sub driver is `redis`; format: `redis://<user>:<password>@<host>:<port>/<db_number>`)	`redis://127.0.0.1:6379/0`	`REDIS_DSN`
`--ignore-header-prefix`	Ignore incoming webhook header prefix (case insensitive; example: `X-Forwarded-`)	`[]`
`--max-request-body-size`	Maximal webhook request body size (in bytes; `0` = unlimited)	`65536`
`--max-requests`	Maximum stored requests per session (max `65535`)	`128`	`MAX_REQUESTS`
`--session-ttl`	Session lifetime (examples: `48h`, `1h30m`)	`168h`	`SESSION_TTL`
`--ws-max-clients`	Maximal websocket clients (`0` = unlimited)	`0`	`WS_MAX_CLIENTS`
`--ws-max-lifetime`	Maximal single websocket lifetime (examples: `3h`, `1h30m`; `0` = unlimited)	`0`	`WS_MAX_LIFETIME`

Environment variables have higher priority than flag values.

Server starting command example:

$ ./webhook-tester serve \
    --port 8080
    --public ./web
    --storage-driver redis
    --pubsub-driver redis
    --redis-dsn redis://redis-host:6379/0
    --max-requests 512
    --ignore-header-prefix X-Forwarded-
    --ignore-header-prefix X-Reverse-Proxy-
    --ws-max-clients 30000
    --ws-max-lifetime 6h

After that you can navigate your browser to http://127.0.0.1:8080/ try to send your first HTTP request for the webhook-tester!

Using docker

All supported image tags can be found here and here.

Just execute in your terminal:

$ docker run --rm -p 8080:8080/tcp tarampampam/webhook-tester:X.X.X serve

Important notice: do not use the latest application tag (this is bad practice). Use versioned tag (like 1.2.3) instead.

Where X.X.X is image tag (application version). Simple docker-compose file below:

version: '3.4'

volumes:
  redis-data:

services:
  app:
    image: tarampampam/webhook-tester:X.X.X
    command: serve --port 8080 --log-json --storage-driver redis --pubsub-driver redis --redis-dsn redis://redis:6379/0
    ports:
      - '8080:8080/tcp' # Open <http://127.0.0.1:8080>

  redis:
    image: redis:6.0.9-alpine
    volumes:
      - redis-data:/data:cached
    ports:
      - 6379

Changes log

Changes log can be found here.

Releasing

New versions publishing is very simple - just "publish" new release using repo releases page.

Release version (and git tag, of course) MUST starts with v prefix (eg.: v0.0.1 or v1.2.3-RC1)

Support

If you find any package errors, please, make an issue in current repository.

License

This is open-sourced software licensed under the MIT License.

frain-dev / webhook-tester