Quick start

WebhookCore is service-first. The quickest path is to run the API, boot the dispatcher, and then send one endpoint plus one delivery through the example.

Prerequisites

• Node 24.x
• pnpm 10.33.x
• Docker with Postgres and Redis support

Local bootstrap

cp .env.example .env
docker compose up -d postgres redis
pnpm install
pnpm dev:api
pnpm dev:dispatcher

Local surfaces:

• API: http://localhost:3030
• Dispatcher health: http://localhost:3031/health
• Postgres: localhost:5432
• Redis: localhost:6379

First useful checks

curl http://127.0.0.1:3030/health
curl http://127.0.0.1:3030/ready
curl http://127.0.0.1:3030/metrics

First delivery flow

pnpm example:outbound-integration

The example:

• registers one endpoint
• creates one delivery
• lists recent deliveries
• schedules a replay

What you should understand after 5 minutes

• WebhookCore wants delivery state explicit and auditable
• endpoint governance, secret rotation, and attempt history are first-class
• replay is part of the core model, not a support-only hack
• QueueFlow can own retry scheduling without becoming hidden magic