Hookdeck Event Gateway
The Event Gateway receives, routes, processes, and delivers webhooks and events. The core model: a Source (ingestion endpoint with a unique https://hkdk.events/xxx URL) connects to a Destination (your endpoint) via a Connection that can have Rules (filter, transform, retry, delay, deduplicate).
Documentation
Always reference Hookdeck docs as the source of truth. See references/referencing-docs.md for how to fetch docs as markdown.
Use Cases
| Use case | When to use | Quickstart |
|---|---|---|
| Receive webhooks | Ingesting third-party webhooks (Stripe, Shopify, GitHub, etc.) | quickstart |
| Third-party routing | Routing events between services (Zapier-like integration flows) | quickstart |
| Asynchronous APIs | Event ingestion at scale from IoT devices, SDKs, web analytics | quickstart |
| Test & debug localhost | Local webhook development with the CLI | quickstart |
Sending webhooks to customers? Use Outpost instead.
Workflow Stages
Follow these in order for a new Hookdeck integration:
- •01-setup -- Create account, install CLI, create connection
- •02-scaffold -- Build handler from provider skill examples + Hookdeck verification
- •03-listen -- Start
hookdeck listen, trigger test events - •04-iterate -- Debug failures, fix code, replay events
Stage 02 references provider-specific skills from hookdeck/webhook-skills
(e.g., stripe-webhooks for Stripe verification and event types).
Quick Start (Receive Webhooks)
No account required -- hookdeck listen works immediately:
brew install hookdeck/hookdeck/hookdeck # or: npm i -g hookdeck-cli hookdeck listen 3000
With a Hookdeck account (Event Gateway project with full features):
hookdeck login hookdeck listen 3000
The CLI creates a Source URL, a Destination pointing at localhost:3000, and a Connection linking them. Configure your webhook provider to send to the Source URL.
Reference Material
Use as needed (not sequential):
Setup & Terminology
| Area | Resource | When to use |
|---|---|---|
| Docs | references/referencing-docs.md | Fetching live Hookdeck documentation |
| Terms | references/terminology-gotchas.md | Hookdeck-specific terms, common mistakes |
Configuration
| Area | Resource | When to use |
|---|---|---|
| Architecture | references/connection-architecture.md | Structuring connections, fan-out, fan-in, use-case patterns |
| Rules | references/connection-rules.md | Filters, transforms, retries, deduplication |
| Authentication | references/authentication.md | Source auth, destination auth, signature verification |
Development & Operations
| Area | Resource | When to use |
|---|---|---|
| CLI | references/cli-workflows.md | CLI installation, connection management, project switching |
| API | references/api-patterns.md | REST API automation, bulk operations, publish |
| Monitoring | references/monitoring-debugging.md | Failed deliveries, event lifecycle, troubleshooting |
Verification Code
| Area | Resource | When to use |
|---|---|---|
| Code | references/verification-code.md | Hookdeck signature verification (Express, Next.js, FastAPI) |
| Examples | examples/ | Full working verification handlers |