# hookstream

> The modern event gateway for webhooks that just work.

hookstream receives, transforms, and delivers webhooks reliably. It includes real-time monitoring, automatic retries, circuit breakers, and instant database sync.

## Docs

### Getting Started

- [Quickstart](https://hookstream.io/docs/quickstart.md): Get up and running with hookstream in under 5 minutes.
- [How It Works](https://hookstream.io/docs/how-it-works.md): Understand hookstream's architecture: sources, connections, and destinations.
- [Key Concepts](https://hookstream.io/docs/concepts.md): Glossary of core hookstream concepts: orgs, environments, sources, events, and more.
- [Your First Webhook](https://hookstream.io/docs/first-webhook.md): Step-by-step tutorial: create a source, send a webhook, and inspect the event.
- [Dashboard Tour](https://hookstream.io/docs/dashboard-tour.md): Visual walkthrough of the hookstream dashboard and its key sections.

### Core Concepts

- [Sources](https://hookstream.io/docs/sources.md): Source types, templates, signature verification, deduplication, and IP filtering.
- [Destinations](https://hookstream.io/docs/destinations.md): Destination types, authentication, timeouts, and provider configurations.
- [Connections](https://hookstream.io/docs/connections.md): Route events from sources to destinations with filters and transforms.
- [Events](https://hookstream.io/docs/events.md): Event lifecycle: received, processed, delivered, and failed states.
- [Delivery Pipeline](https://hookstream.io/docs/delivery-pipeline.md): Pipeline stages: ingest, filter, transform, deliver, retry, DLQ.
- [Filters & Transforms](https://hookstream.io/docs/filters-transforms.md): 9 filter operators and JSONata transforms for event routing and payload reshaping.
- [Topics & Pub/Sub](https://hookstream.io/docs/topics-pubsub.md): Create topics, subscribe destinations, and publish with fan-out delivery.
- [Instant Database](https://hookstream.io/docs/instant-database.md): Collections, upsert engine, schema inference, and data export.

### API Reference

- [Authentication](https://hookstream.io/docs/api/authentication.md): Overview of hookstream authentication methods: API keys and session cookies.
- [API Keys](https://hookstream.io/docs/api/api-keys.md): Create, list, and revoke API keys for programmatic access.
- [Sources](https://hookstream.io/docs/api/sources.md): Manage webhook sources — your inbound endpoints that receive events.
- [Destinations](https://hookstream.io/docs/api/destinations.md): Manage event destinations — where your webhooks get delivered.
- [Connections](https://hookstream.io/docs/api/connections.md): Link sources to destinations with optional filters and transforms.
- [Events](https://hookstream.io/docs/api/events.md): Browse, search, and retry webhook events received by your sources.
- [Delivery Attempts](https://hookstream.io/docs/api/delivery-attempts.md): Inspect individual delivery attempts with status codes, latency, and response bodies.
- [Metrics](https://hookstream.io/docs/api/metrics.md): Query event volume, delivery success rates, and latency percentiles.
- [Issues](https://hookstream.io/docs/api/issues.md): Track delivery failures auto-grouped into actionable issues.
- [Notification Channels](https://hookstream.io/docs/api/notification-channels.md): Configure where alert notifications are sent (webhook, Slack, Discord, or email).
- [Alert Rules](https://hookstream.io/docs/api/alert-rules.md): Define threshold-based alerts for error rates, latency, volume, DLQ, and circuit breakers.
- [Collections](https://hookstream.io/docs/api/collections.md): Instant Database — sync webhook data into queryable collections with schema inference.
- [Topics](https://hookstream.io/docs/api/topics.md): Pub/sub topics for fan-out delivery with per-subscription filters and transforms.
- [Replay](https://hookstream.io/docs/api/replay.md): Replay historical events to a destination with rate limiting and job tracking.
- [Test Sessions](https://hookstream.io/docs/api/test-sessions.md): Ephemeral webhook testing sessions with inspection, forwarding, and export.
- [Ingest](https://hookstream.io/docs/api/ingest.md): Public webhook ingestion endpoint — where external services send events.
- [Tools API](https://hookstream.io/docs/api/tools-api.md): Backend endpoints for free developer tools — health check, scheduler, idempotency tester.
- [WebSockets](https://hookstream.io/docs/api/websockets.md): Real-time WebSocket connections for live event streaming and inbound sources.
- [Errors](https://hookstream.io/docs/api/errors.md): Standard error response format and common HTTP status codes.
- [Pagination & Rate Limits](https://hookstream.io/docs/api/pagination-rate-limits.md): Cursor-based pagination and rate limiting across all API endpoints.
- [Billing](https://hookstream.io/docs/api/billing.md): Check usage, create checkout sessions, manage subscriptions, and view invoices.

### Guides

- [Signature Verification](https://hookstream.io/docs/guides/signature-verification.md): Verify incoming webhooks with HMAC-SHA256, SHA1, or Standard Webhooks.
- [Retry Strategies](https://hookstream.io/docs/guides/retry-strategies.md): Configure exponential, linear, or fixed backoff for delivery retries.
- [Circuit Breaker](https://hookstream.io/docs/guides/circuit-breaker.md): Understand circuit breaker states, thresholds, and reset behavior.
- [Dead Letter Queue](https://hookstream.io/docs/guides/dead-letter-queue.md): DLQ flow, manual retry, and bulk retry for permanently failed events.
- [IP Filtering](https://hookstream.io/docs/guides/ip-filtering.md): Configure IP allowlists and denylists with CIDR notation for sources.
- [Deduplication](https://hookstream.io/docs/guides/deduplication.md): Prevent duplicate webhook processing with payload hash or field-based dedup.
- [Schema Validation](https://hookstream.io/docs/guides/schema-validation.md): Validate incoming payloads against JSON Schema with reject or warn mode.
- [Event Replay](https://hookstream.io/docs/guides/event-replay.md): Replay historical events to any destination with rate limiting.
- [Webhook Testing](https://hookstream.io/docs/guides/webhook-testing.md): Ephemeral test sessions, graduation, forwarding, and the testing workflow.
- [Real-Time Streaming](https://hookstream.io/docs/guides/real-time-streaming.md): WebSocket push, channels, and polling fallback for live updates.
- [Monitoring & Alerts](https://hookstream.io/docs/guides/monitoring-alerts.md): Alert rules (5 types), notification channels, and auto-resolve behavior.
- [Outbound Signing](https://hookstream.io/docs/guides/outbound-signing.md): Sign outbound webhook requests with HMAC for receiver verification.
- [Billing & Plans](https://hookstream.io/docs/guides/billing.md): Understand hookstream plans, usage limits, and how to manage your subscription.

### Destination Providers

- [HTTP / Webhook](https://hookstream.io/docs/providers/http.md): Configure HTTP/webhook destinations with custom headers, auth, and timeouts.
- [AWS SQS](https://hookstream.io/docs/providers/aws-sqs.md): Push events to Amazon SQS queues with IAM authentication.
- [AWS S3](https://hookstream.io/docs/providers/aws-s3.md): Write events to S3 buckets with configurable key prefixes and partitioning.
- [AWS EventBridge](https://hookstream.io/docs/providers/aws-eventbridge.md): Publish events to EventBridge event buses with custom detail types.
- [GCP Pub/Sub](https://hookstream.io/docs/providers/gcp-pubsub.md): Publish events to Google Cloud Pub/Sub topics with service account auth.
- [Kafka](https://hookstream.io/docs/providers/kafka.md): Produce events to Kafka topics via Confluent REST Proxy.
- [RabbitMQ](https://hookstream.io/docs/providers/rabbitmq.md): Publish events to RabbitMQ exchanges via the HTTP Management API.
- [WebSocket](https://hookstream.io/docs/providers/websocket.md): Broadcast events to connected WebSocket clients.

### CLI Reference

- [Overview](https://hookstream.io/docs/cli/overview.md): What the hookstream CLI does and when to use it.
- [Installation](https://hookstream.io/docs/cli/installation.md): Install the CLI via npm, configure settings, and set up environment variables.
- [Commands](https://hookstream.io/docs/cli/commands.md): Complete command reference with examples for every CLI command.
- [Authentication](https://hookstream.io/docs/cli/authentication.md): API key auth, --api-key flag, environment variables, and config file.

### AI & LLM

- [AI Integration](https://hookstream.io/docs/ai/overview.md): How to use hookstream with AI tools, LLMs, and coding assistants.
- [Skills & IDE](https://hookstream.io/docs/ai/skills.md): Install hookstream skills in Claude Code, Cursor, and other AI-powered IDEs.
- [Agent API](https://hookstream.io/docs/ai/agent-api.md): Full reference for using hookstream test sessions as an AI agent workspace.

## API

- Base URL: https://hookstream.io/v1
- Auth: `X-API-Key` header or session cookies (dashboard)
- API key format: `hs_live_<64 hex>` or `hs_test_<64 hex>`
- OpenAPI spec: https://hookstream.io/v1/openapi.json
- Docs: https://hookstream.io/docs/api/authentication

## Tools

- Free webhook tools at https://hookstream.io/tools (no auth)
- AI Agent API: `POST /v1/agent/sessions` (no auth, creates ephemeral webhook endpoint)
- Skills file: https://hookstream.io/hookstream.skills.md

## Links

- Website: https://hookstream.io
- Dashboard: https://hookstream.io/dashboard
- Free Testing: https://hookstream.io/test
- Full docs: https://hookstream.io/llms-full.txt