# Hookdeck Outpost documentation index Everything under /docs/outpost. Outpost is outbound event delivery (webhooks, queues, buses) for your product, with a managed service or self-hosted deployment. Fetch each `.md` URL below for full page text. - [API Reference](/docs/outpost/api.md) ### Getting Started - [Overview](/docs/outpost/overview.md): Outbound webhooks infrastructure for delivering platform events to webhooks, queues, and streams — available managed or self-hosted. - [Concepts](/docs/outpost/concepts.md): Core concepts and architecture of Outpost: tenants, destinations, topics, events, and delivery attempts. - [SDKs](/docs/outpost/sdks.md): An overview of the Outpost SDKs for Go, TypeScript, and Python. - [Quickstarts](/docs/outpost/quickstarts/overview.md): Hookdeck managed Outpost and self-hosted deployment quickstarts. - [Self-Hosting](/docs/outpost/self-hosting/architecture.md): The architecture of Outpost for self-hosted deployments. ### Features - [Multi-Tenancy](/docs/outpost/features/multi-tenancy.md): How Outpost isolates destinations, events, and delivery per tenant in your platform. - [Topics](/docs/outpost/features/topics.md): Categorize events with topics and control which destinations receive which events. - [Destination Filters](/docs/outpost/features/filter.md): Route events to destinations selectively based on event content using flexible filter rules. - [Event Delivery & Retries](/docs/outpost/features/event-delivery.md): How Outpost delivers events, tracks attempts, and retries on failure. - [Operator Events & Alerts](/docs/outpost/features/operator-events.md): Subscribe to lifecycle events from your Outpost deployment for alerting, automation, and auditing. - [Tenant Portal](/docs/outpost/features/tenant-user-portal.md): An embedded self-service portal for your customers to manage destinations and inspect events. - [Metrics](/docs/outpost/features/metrics.md): Query event and delivery attempt metrics to monitor throughput, reliability, and error trends. - [OpenTelemetry](/docs/outpost/features/opentelemetry.md): Export Outpost performance metrics via OpenTelemetry to your observability platform. ### Destinations - [Webhook](/docs/outpost/destinations/webhook.md): Deliver events via HTTP POST to any URL endpoint, with customizable headers and HMAC signature verification. - [Hookdeck Event Gateway](/docs/outpost/destinations/hookdeck.md): Route events through Hookdeck for advanced delivery with retries, transformations, filtering, and observability. - [AWS SQS](/docs/outpost/destinations/aws-sqs.md): Deliver events to an Amazon SQS queue with metadata as message attributes. - [AWS Kinesis](/docs/outpost/destinations/aws-kinesis.md): Stream events to an Amazon Kinesis Data Stream with configurable partition keys. - [AWS S3](/docs/outpost/destinations/aws-s3.md): Store events as JSON objects in an Amazon S3 bucket with configurable key templates and storage classes. - [GCP Pub/Sub](/docs/outpost/destinations/gcp-pubsub.md): Publish events to a Google Cloud Pub/Sub topic using a service account. - [Azure Service Bus](/docs/outpost/destinations/azure-service-bus.md): Send events to an Azure Service Bus queue or topic with metadata as application properties. - [RabbitMQ](/docs/outpost/destinations/rabbitmq.md): Send events to a RabbitMQ exchange via AMQP with the event topic as the routing key. - [Apache Kafka](/docs/outpost/destinations/kafka.md): Publish events to an Apache Kafka topic with SASL authentication and a configurable partition key. ### Guides - [Migrate to Outpost](/docs/outpost/guides/migrate-to-outpost.md): Migrate your existing webhook infrastructure to Outpost. - [Building your own UI](/docs/outpost/guides/building-your-own-ui.md): Build your own UI for users to manage their destinations and view their events using the Outpost API. ### Publishing - [Publishing Events](/docs/outpost/publishing/events.md): How to publish events to Outpost for delivery to tenant destinations. - [Publish from Hookdeck Event Gateway](/docs/outpost/publishing/publish-from-hookdeck-event-gateway.md): Configure Outpost to ingest published events from Hookdeck Event Gateway. - [Publish from RabbitMQ](/docs/outpost/publishing/publish-from-rabbitmq.md): Configure Outpost to ingest published events from a RabbitMQ exchange and queue. - [Publish from SQS](/docs/outpost/publishing/publish-from-sqs.md): Configure Outpost to ingest published events from an AWS SQS queue. - [Publish from GCP Pub/Sub](/docs/outpost/publishing/publish-from-gcp-pubsub.md): Configure Outpost to ingest published events from a GCP Pub/Sub topic and subscription. ### Platform (Managed Only) - [Organizations](/docs/platform/organizations.md) - [Projects](/docs/platform/outpost-projects.md) ## Quickstarts - [Hookdeck Outpost: curl](/docs/outpost/quickstarts/hookdeck-outpost-curl.md): Use the REST API with curl to create a tenant, destination, and publish an event. - [Hookdeck Outpost: TypeScript](/docs/outpost/quickstarts/hookdeck-outpost-typescript.md): Use the TypeScript SDK to create a tenant, destination, and publish an event. - [Hookdeck Outpost: Python](/docs/outpost/quickstarts/hookdeck-outpost-python.md): Use the Python SDK to create a tenant, destination, and publish an event. - [Hookdeck Outpost: Go](/docs/outpost/quickstarts/hookdeck-outpost-go.md): Use the Go SDK to create a tenant, destination, and publish an event. ## Self-Hosting ### Overview - [Deployment](/docs/outpost/self-hosting/deployment.md): Deploy Outpost services, choose runtime distribution, and plan dependencies and resource allocation. - [Configuration Reference](/docs/outpost/self-hosting/configuration.md): Configuration options for Outpost — environment variables for self-hosted deployments and dashboard settings for managed Outpost. - [Github Repository](https://github.com/hookdeck/outpost) ### Quickstarts - [Deploy on Railway](/docs/outpost/quickstarts/railway.md) - [Deploy with Docker](/docs/outpost/quickstarts/docker.md) - [Deploy on Kubernetes](/docs/outpost/quickstarts/kubernetes.md) ### Guides - [Logging](/docs/outpost/guides/logging.md) - [Bring Your Own Message Queues](/docs/outpost/guides/byo-mqs.md) - [Azure Service Bus Internal MQ](/docs/outpost/guides/service-bus-internal-mq.md) - [Migrations](/docs/outpost/guides/migration.md) - [Event & Delivery Log](/docs/outpost/guides/event-delivery-log.md) - [Redis Troubleshooting](/docs/outpost/guides/troubleshooting-redis.md) ### Changelog - [Upgrade to v0.12](/docs/outpost/changelog/upgrade-v0.12.md) - [Upgrade to v0.13](/docs/outpost/changelog/upgrade-v0.13.md) - [Upgrade to v0.14](/docs/outpost/changelog/upgrade-v0.14.md) - [Upgrade to v0.16](/docs/outpost/self-hosting/upgrade-v0.16.md): Breaking changes and migration steps for upgrading Outpost from v0.15 to v0.16. - [Upgrade to v0.17](/docs/outpost/changelog/upgrade-v0.17.md) ## Outpost API Reference ### Introduction - [Introduction](/docs/outpost/api.md#introduction) - [Authentication](/docs/outpost/api.md#authentication) - [Errors](/docs/outpost/api.md#errors) - [Rate limit](/docs/outpost/api.md#rate-limit) - [Openapi](/docs/outpost/api.md#openapi) - [Sdks](/docs/outpost/api.md#sdks) ### Configure - [Configure](/docs/outpost/api/configure.md) - [Tenants](/docs/outpost/api/configure.md#tenants) - [Destinations](/docs/outpost/api/configure.md#destinations) - [Configuration](/docs/outpost/api/configure.md#configuration) ### Publishing - [Publishing](/docs/outpost/api/publishing.md) - [Publish](/docs/outpost/api/publishing.md#publish) - [Retry](/docs/outpost/api/publishing.md#retry) ### Inspect - [Inspect](/docs/outpost/api/inspect.md) - [Events](/docs/outpost/api/inspect.md#events) - [Attempts](/docs/outpost/api/inspect.md#attempts) - [Metrics](/docs/outpost/api/inspect.md#metrics) ### Resources - [Resources](/docs/outpost/api/resources.md) - [Destination Types](/docs/outpost/api/resources.md#destination-types) - [Topics](/docs/outpost/api/resources.md#topics) - [Health](/docs/outpost/api/resources.md#health) ## Other pages - [Upgrade to v0.12](/docs/outpost/self-hosting/changelog/upgrade-v0.12.md): Breaking changes and migration steps for upgrading Outpost from v0.11 to v0.12. - [Upgrade to v0.13](/docs/outpost/self-hosting/changelog/upgrade-v0.13.md): Breaking changes and migration steps for upgrading Outpost from v0.12 to v0.13. - [Upgrade to v0.14](/docs/outpost/self-hosting/changelog/upgrade-v0.14.md): Breaking changes and migration steps for upgrading Outpost from v0.13 to v0.14. - [Upgrade to v0.17](/docs/outpost/self-hosting/changelog/upgrade-v0.17.md): Breaking changes and migration steps for upgrading Outpost from v0.16 to v0.17. - [Bring Your Own Message Queues](/docs/outpost/self-hosting/guides/byo-mqs.md): Disable auto-provisioning and manually configure Outpost internal message queues across supported providers. - [Event & Delivery Log](/docs/outpost/self-hosting/guides/event-delivery-log.md): Overview of event and delivery log storage, querying, and retention behavior for self-hosted Outpost. - [Logging](/docs/outpost/self-hosting/guides/logging.md): Configure application and audit logging for self-hosted Outpost deployments. - [Schema Migration Guide](/docs/outpost/self-hosting/guides/migration.md): Plan, apply, verify, and clean up Outpost schema migrations safely in self-hosted environments. - [Configure Azure Service Bus as the Outpost Internal Message Queue](/docs/outpost/self-hosting/guides/service-bus-internal-mq.md): Set up Azure Service Bus topics, subscriptions, and credentials for Outpost internal messaging. - [Redis Troubleshooting](/docs/outpost/self-hosting/guides/troubleshooting-redis.md): Diagnose and fix common Redis connectivity and configuration issues for self-hosted Outpost. - [Deploy with Docker](/docs/outpost/self-hosting/quickstarts/docker.md): Run Outpost locally using Docker Compose with RabbitMQ or AWS SQS via LocalStack. - [Deploy on Kubernetes](/docs/outpost/self-hosting/quickstarts/kubernetes.md): Run Outpost on Kubernetes using Minikube and Helm with RabbitMQ. - [Deploy on Railway](/docs/outpost/self-hosting/quickstarts/railway.md): Deploy Outpost to Railway with a one-click deployment template.