# Hookdeck documentation index

Everything under /docs. Fetch individual .md URLs from this list for full content.
Canonical doc URLs also support content negotiation: send Accept: text/markdown on any /docs/... URL.

## Documentation

- [Access Control](/docs/platform/members.md): Team membership lifecycle and role assignment
- [AI Agent Resources](/docs/ai-agent-resources.md): Hub for AI agent resources: llms.txt, markdown docs, Hookdeck MCP server (CLI), agent-skills, webhook-skills, and CLI.
- [API Keys](/docs/platform/api-keys.md): Manage organization and project API keys, project access, permission scopes, key rotation, and revocation
- [Authentication & Verification](/docs/authentication.md): Guide to authenticating inbound/outbound webhook requests and API access with signature verification, basic auth, and API keys
- [Billing](/docs/platform/billing.md): Manage organization billing and subscription
- [Bookmarks](/docs/bookmarks.md): Save webhook event
- [Build Asynchronous APIs with Hookdeck](/docs/use-cases/asynchronous-apis.md): Decouple producers and consumers to turn webhook flows into async APIs
- [Cancellations](/docs/cancellations.md): Cancel upcoming delivery attempts for your events
- [Connect AI Agents and LLM Workflows to Webhooks with Hookdeck Event Gateway](/docs/use-cases/ai-agents.md): Trigger AI agents and LLM workflows from webhooks, and receive webhooks from AI providers.
- [Connections](/docs/connections.md): Configuration between Source(s), Destination(s) and Rules to manage webhook event streams
- [Deduplication](/docs/deduplication.md): Remove redundant events based on configurable matching strategies
- [Delivery Groups](/docs/delivery-groups.md): Configure segmented event queues, delivery rates, overrides, metrics, and backpressure alerts on a destination by property value.
- [Destinations](/docs/destinations.md): Define where Hookdeck delivers events after processing
- [Event Gateway Projects](/docs/platform/event-gateway-projects.md): Isolated environments with separate configs
- [Events & Attempts](/docs/events.md): Events Hookdeck generates and delivers to a Destination
- [Filters](/docs/filters.md): Define rules to include or exclude webhook events
- [Forwarding to a destination](/docs/inspect/destinations.md): Forward Inspect-captured requests to an HTTP URL or to localhost with the Hookdeck CLI (hookdeck listen with --cli-key)
- [Hookdeck Basics](/docs/hookdeck-basics.md): Core concepts and terminology to get oriented fast
- [Inspect](/docs/inspect.md): Free webhook test URLs (Source URLs) with no account at inspect.hookdeck.com — capture requests, read their headers and bodies, forward them to localhost, and wait for them over HTTP
- [Inspecting requests](/docs/inspect/inspecting-requests.md): Read captured webhook headers and bodies in Inspect, copy a request as cURL or share it with an agent, read forwarded responses, retry, rejected requests
- [Issue Triggers](/docs/issue-triggers.md): Automate alerts when specific issue patterns occur
- [Issues & Notifications](/docs/issues.md): Track delivery failures, request rejections, and surface actionable errors
- [Limits](/docs/limits.md): Default and per-plan limits for payload size, throughput, retries, and delivery timeouts, how to configure them, and how to request increases
- [MCP & Skills](/docs/mcp.md): Guide for Hookdeck MCP setup, MCP vs skills usage, skills installation, and AI-friendly documentation resources.
- [Metrics](/docs/metrics.md): Built-in dashboards for throughput, latency, and error rates
- [Organizations](/docs/platform/organizations.md): Manage team access, roles, and billing across projects
- [Outpost Projects](/docs/platform/outpost-projects.md): Isolated environments with separate configs
- [Quickstart: Asynchronous APIs with Hookdeck](/docs/use-cases/asynchronous-apis/quickstart.md): How to configure Hookdeck to decouple producers and consumers into Async API
- [Quickstart: Receive Webhooks with Hookdeck](/docs/use-cases/receive-webhooks/quickstart.md): How to configure Hookdeck to receive webhook events
- [Quickstart: Third party event routing with Hookdeck](/docs/use-cases/third-party-routing/quickstart.md): How to configure Hookdeck to manage routing of webhook events between third party applications
- [Receive and Process Webhooks with Hookdeck](/docs/use-cases/receive-webhooks.md): Ingests every third-party webhook events.
- [Requests](/docs/requests.md): Webhooks that Hookdeck consumes from a Source
- [Retries](/docs/retries.md): Control retry logic, backoff, and dead-letter behavior
- [Source URLs](/docs/inspect/sources.md): Create and manage Inspect Source URLs (webhook test URLs), set a Source Type, supported HTTP methods, signature checks, sharing and access, retention
- [Sources](/docs/sources.md): Set up external services that send webhooks into Hookdeck
- [Test and Debug Webhooks on Your Localhost](/docs/use-cases/test-debug-localhost.md): Test webhook integrations locally before deploying to production using Hookdeck CLI
- [Test Webhooks on Localhost with Hookdeck CLI Quickstart](/docs/use-cases/test-debug-localhost/quickstart.md): How to configure Hookdeck CLI for local webhook testing and debugging
- [Third Party Routing Overview](/docs/use-cases/third-party-routing.md): Manage routing of webhooks between third-party applications.
- [Transformations](/docs/transformations.md): Run Node.js-compatible JavaScript, including bundled npm libraries, on every event before delivery to reshape payloads, verify tokens, and decode or generate binary content
- [User profile](/docs/platform/user-profile.md): User profile authentication and account settings
- [Webhook Library](/docs/inspect/webhooks-library.md): Send sample provider webhook payloads to an Inspect Source URL for testing

## Guides

- [A Guide to Hookdeck Connections](/docs/guides/connections-walkthrough.md): End-to-end walkthrough of creating and managing connections
- [Control Throughput and Queue Events to Prevent Spikes](/docs/guides/control-throughput-queue-events.md): Buffer bursts and throttle delivery to protect consumers.
- [Decode and Verify JWTs with a Transformation](/docs/guides/how-to-decode-and-verify-jwts.md): Decode and verify bearer JWTs in a Hookdeck transformation: HS256, RS256 and ES256 with built-in crypto, jose with a local JWKS, claim checks, and dropping invalid tokens with a filter
- [Decompress Gzip and Zip Payloads with a Transformation](/docs/guides/how-to-decompress-gzip-and-zip-payloads.md): Decompress application/gzip, Content-Encoding: gzip and application/zip webhook payloads into JSON in a Hookdeck transformation with node:zlib gunzipSync and inflateRawSync or bundled fflate, and gzip payloads before delivery
- [Deduplication Implementation Guide](/docs/guides/deduplication-guide.md): Comprehensive implementation guide for webhook deduplication with real-world use cases
- [Extract Text and Data from a PDF with a Transformation](/docs/guides/how-to-extract-data-from-pdf-payloads.md): Parse PDF webhook payloads in a Hookdeck transformation: extract text with unpdf, read title, author and page count with pdf-lib, bundle with esbuild, and deliver JSON
- [Generate an Image from Text with a Transformation](/docs/guides/how-to-generate-an-image-from-text.md): Render text from a JSON webhook into a PNG (or SVG) image in a Hookdeck transformation using node:zlib, returning a Buffer to deliver a binary image/png payload
- [Handle Multipart Requests](/docs/guides/multipart-requests.md): How Hookdeck parses multipart/form-data requests into fields and file metadata for search, filters, and transformations.
- [Handling Thin Events with the Hookdeck Event Gateway](/docs/guides/handling-thin-events-with-hookdeck.md): Guide to using Hookdeck Event Gateway to handle thin events at scale, focusing on rate limiting, deduplication, and transformation patterns
- [How to Fan Out Webhooks to Different Services](/docs/guides/how-fan-out-webhooks-different-services.md): Duplicate and route events to multiple downstream apps
- [How to Filter and Route Events](/docs/guides/how-to-filter-and-route-events.md): Define rules to transform, filter, and route webhooks.
- [How to Gain Full Observability of Your Event Flows](/docs/guides/how-to-gain-full-observability-of-your-event-flows.md): Searchable logs, metrics, and traces for every webhook event.
- [How to Order Transformations and Filters](/docs/guides/how-to-order-transformations-and-filters.md): Control whether transformations run before or after filters to simplify logic, avoid unnecessary processing, and clean up filter-only data.
- [How to Prevent Webhook Spikes from Crashing Your Servers](/docs/guides/how-to-protect-server-from-crashing-caused-webhook-spikes.md): Buffer traffic surges with queues and rate limits
- [How to Receive Webhooks on HTTP Endpoints](/docs/guides/how-receive-webhook-http-endpoints.md): Set up public endpoints and test with cURL
- [How to Use Hookdeck with Cloudflare Bot Fight Mode](/docs/guides/how-to-use-hookdeck-with-cloudflare-bot-fight-mode.md): Keep webhook traffic flowing when Cloudflare is blocking bots
- [Implement the Fan-In Pattern for Webhooks](/docs/guides/how-to-fan-in-webhooks.md): Aggregate webhook events from many Sources into one consumer
- [Manage Connections with the Hookdeck CLI](/docs/guides/manage-connections-with-cli.md): Comprehensive guide for managing Hookdeck connections using CLI v1.2.0+ including IaC patterns, blue-green deployments, and CI/CD integration.
- [Manage Multiple Environments with Hookdeck Projects](/docs/guides/how-to-manage-environments.md): Use projects to separate dev, staging, and production pipelines
- [Migrate to Binary-Safe Multipart Handling](/docs/guides/multipart-binary-migration.md): Move multipart/form-data connections from legacy string bodies to binary-safe fields and files.
- [PagerDuty Integration Guide](/docs/guides/pagerduty-integration.md): Create on-call alerts from Hookdeck issues via PagerDuty
- [Pause and Resume Connections](/docs/guides/how-to-pause-connections.md): Stop and resume deliveries without losing webhook events.
- [Sentry Integration Guide](/docs/guides/sentry-integration.md): Create Sentry issues from Hookdeck issues and sync their status both ways
- [Test Webhooks Locally with Hookdeck CLI](/docs/guides/how-to-test-webhooks-locally.md): Forward webhooks to your local server and replay them using Hookdeck CLI
- [Transform Event Payload Content-Type (e.g., x-www-form-urlencoded to JSON)](/docs/guides/how-to-transform-event-payload-content-type.md): Convert webhook events between JSON, form-encoded, and other formats
- [Transform Multipart File Uploads](/docs/guides/how-to-transform-multipart-file-uploads.md): Access multipart/form-data file content as a Buffer in Hookdeck transformations: parse a CSV upload into JSON with papaparse, replace, rename, add and remove files, build a multipart upload from JSON, and base64-encode files for JSON
- [Use Event Gateway as a Forward Proxy for MCP Events](/docs/guides/how-to-use-event-gateway-as-mcp-events-forward-proxy.md): Set up Hookdeck Event Gateway as the forward proxy for MCP Events (SEP-3415) webhook delivery: an MCP_EVENTS source holding the subscription's whsec_ secret, the verification handshake, Standard Webhooks signature verification at the edge (401 for a bad signature), deduplication on webhook-id, retries, delivery to an agent over HTTP or the Hookdeck CLI, optional Standard Webhooks signing of every delivery attempt to the agent, and the current limits.
- [Verify Incoming Webhook Signatures](/docs/guides/how-to-verify-incoming-webhooks.md): How to validate different webhook signatures algorithms

## API Reference

- [API Reference (Overview)](/docs/api.md): REST API overview, authentication, paging, errors.
- [API: Configure](/docs/api/configure.md)
- [API: Inspect](/docs/api/inspect.md)
- [API: Publish](/docs/api/publish.md)
- [API: Bulk Operations](/docs/api/bulk.md)
- [API: Rules](/docs/api/rules.md)
- [API: Publish](/docs/api/publish.md)
- [API: Rules](/docs/api/rules.md)

## Platform API Reference

- [Platform API Reference (Overview)](/docs/platform/api.md): Organization-scoped authentication, base URL, and the endpoint index.
- [Platform API: Resources](/docs/platform/api/resources.md)

## CLI Reference

- [CLI Reference](/docs/cli.md): Hookdeck CLI overview and commands.
- [CLI: Attempt](/docs/cli/attempt.md)
- [CLI: Connection](/docs/cli/connection.md)
- [CLI: Destination](/docs/cli/destination.md)
- [CLI: Event](/docs/cli/event.md)
- [CLI: Issues](/docs/cli/issues.md)
- [CLI: Listen](/docs/cli/listen.md)
- [CLI: Mcp](/docs/cli/mcp.md)
- [CLI: Metrics](/docs/cli/metrics.md)
- [CLI: Project](/docs/cli/project.md)
- [CLI: Request](/docs/cli/request.md)
- [CLI: Source](/docs/cli/source.md)
- [CLI: Transformation](/docs/cli/transformation.md)