outpost

Hookdeck Outpost

Outbound event delivery: publish platform events to tenants’ destinations (webhooks, queues, cloud buses—see supported destinations). Open source on GitHub; managed on Hookdeck Cloud or self-hosted.

Single source of truth: Use Hookdeck Outpost documentation for concepts, API, quickstarts, and UI guidance. This skill links there and adds agent workflow notes under references/.

API base URL and credentials

The managed Outpost API is at https://api.outpost.hookdeck.com/2025-07-01 — not api.hookdeck.com. Authenticate with a Hookdeck project API key that belongs to an Outpost project (Hookdeck Dashboard → your Outpost project → Settings → Secrets), sent as a bearer token. Keep the key server-side.

export OUTPOST_API_BASE_URL="https://api.outpost.hookdeck.com/2025-07-01"
export OUTPOST_API_KEY="..."   # key from an Outpost project

# Upsert a tenant: 201 if Outpost created it, 200 if it already existed
curl --request PUT "$OUTPOST_API_BASE_URL/tenants/customer_acme_001" \
  --header "Authorization: Bearer $OUTPOST_API_KEY"

Hookdeck has organization API keys and project API keys. For Outpost server work, use a project API key — and the project it belongs to is what matters.

A key for a non-Outpost project authenticates against api.hookdeck.com and works with the Hookdeck CLI, so it looks correct, but returns 404 Not Found on most Outpost routes. Read that 404 as this key is for the wrong project, not "Outpost is not provisioned on this account", and ask the user for a key from an Outpost project. Do not fall back to building the task on api.hookdeck.com — that is the Event Gateway, a different product.

Documentation index for agents

• llms.txt: https://hookdeck.com/docs/outpost/llms.txt — plain-text map of doc pages as .md URLs; fetch once when you need the full tree or many pages.
• Concepts: Tenants, destinations, topics, publish
• API reference: REST / OpenAPI; self-hosted spec file: https://github.com/hookdeck/outpost/blob/main/docs/apis/openapi.yaml
• SDKs: Overview — for TypeScript, Python, or Go, follow that language’s quickstart for correct signatures.
• Building your own UI: Guide — screen flow, BFF pattern, implementation checklists.
• Destinations / topics: Destination types · Topics and subscriptions

Quickstarts (smallest path first)

Use the official managed-Outpost walkthroughs before opening full-stack examples in this repo:

curl (HTTP only)	Hookdeck Outpost curl quickstart
TypeScript	TypeScript quickstart
Python	Python quickstart
Go	Go quickstart

Compact link list: references/outpost-quickstarts.md.

Test webhook destination URLs (README and docs)

When you need a throwaway HTTPS URL for a webhook destination (quickstarts, curl examples, “verify delivery”):

• Prefer Hookdeck Console — create a Source, copy its URL (e.g. https://hkdk.events/…), and inspect or replay deliveries in one place. This is the Hookdeck-native default for agents and humans.

Fast path for agents

1. Start with references/outpost-scope.md to pick Quick path vs New minimal app vs Existing app.
2. If scope is ambiguous, default to the smallest quickstart-shaped artifact.
3. Fetch only the language quickstart you need (curl, TypeScript, Python, Go).
4. Use references/outpost-verify.md before finishing.
5. Open full-stack examples only when the task clearly requires BFF/UI integration patterns.

Scope and verification (agent workflow)

Dashboard-style guidance (no {{PLACEHOLDERS}} — those stay dashboard-only):

• references/outpost-scope.md — three-path ladder, default-to-smallest, language vs architecture, topic reconciliation, SDK vs OpenAPI / BFF pointers with links to Building your own UI anchors.
• references/outpost-verify.md — trimmed “before you stop” checklist.

BFF / wire JSON: Authentication · Wire JSON, SDK responses, and your UI

Supported destination types

Available: Webhooks (HTTP), Hookdeck Event Gateway, AWS SQS, AWS Kinesis, AWS S3, Azure Service Bus, GCP Pub/Sub, RabbitMQ (AMQP), Kafka

Planned: AWS EventBridge

Deployment and API pointers

• Managed: Hookdeck Outpost docs and per-language quickstarts.
• Self-hosted quickstarts: Docker, Kubernetes, Railway, Configuration.
• API reference: Outpost REST / OpenAPI.
• Base URL and auth: https://api.outpost.hookdeck.com/2025-07-01 with a project API key for an Outpost project — see API base URL and credentials.

Full-stack reference examples (advanced)

Use only when the task needs realistic BFF + dashboard patterns—not for “smallest example” (use Quickstarts and llms.txt first).

Integration maps (read before opening trees):

• Next.js: references/nextjs-saas-integration-map.md
• FastAPI: references/fastapi-saas-integration-map.md

Treat examples as references, not copy-paste scaffolds. Prefer the user’s codebase and use maps for Outpost-specific behavior (server-only Outpost project API key, tenant mapping, BFF routes, domain publish).

Example	Stack	Location
SaaS (Next.js)	App Router + @hookdeck/outpost-sdk + dashboard UI	examples/nextjs-saas/ — README
SaaS (FastAPI + React)	FastAPI BFF (httpx → Outpost) + template UI	examples/fastapi-saas/ — README

Dependency and version pins live in the example manifests (package.json, pyproject.toml).

How to use the examples: Read the integration maps and README overviews first; open other files only when they match the user’s task.

Tests: npm test in nextjs-saas (Vitest); pytest test_outpost_wire.py in fastapi-saas/backend via ./scripts/test-examples.sh outpost. Next.js example uses npm.

Future skills

Destination-specific skills (outpost-webhooks, outpost-sqs, …) may be added as documentation matures.

Related skills

• hookdeck — skill router for Hookdeck products
• event-gateway — Hookdeck Event Gateway (inbound webhooks)