outpost について
Hookdeck Outpost は、プラットフォームのイベントをWebhook、キュー、クラウドバスなどのテナントの宛先へ配信します。このスキルは、API、ドキュメント、クイックスタートと、マネージドまたはセルフホストの導入方法を案内します。
主な機能
- 01テナントの宛先へイベントを配信
- 02Webhook、キュー、クラウドバスに対応
- 03マネージドまたはセルフホストで導入
- 04REST APIと言語別クイックスタート
- 05BFFとダッシュボードの統合ガイド
活用シーン
- 01プラットフォームイベントをテナントのWebhookへ送信
- 02イベントをキューやクラウドバスへルーティング
- 03クイックスタートでOutpostアプリを構築
- 04ダッシュボードとBFFの統合を計画
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ hookdeck/ agent-skills --skill outpostインストール後、Claude Code で/outpostを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
examples/fastapi-saas/.gitattributes.gitignore.pre-commit-config.yamlexamples/fastapi-saas/.copier/.copier-answers.yml.jinjaupdate_dotenv.pyexamples/fastapi-saas/.github/dependabot.ymlFUNDING.ymllabeler.ymlexamples/fastapi-saas/.github/DISCUSSION_TEMPLATE/questions.ymlexamples/fastapi-saas/.github/ISSUE_TEMPLATE/config.ymlprivileged.ymlexamples/fastapi-saas/.github/workflows/add-to-project.ymldeploy-production.ymldeploy-staging.ymldetect-conflicts.ymlissue-manager.ymllabeler.ymllatest-changes.ymlplaywright.ymlpre-commit.ymlsmokeshow.ymltest-backend.ymltest-docker-compose.ymlexamples/fastapi-saas/backend/.dockerignore.gitignorealembic.iniexamples/fastapi-saas/backend/app/__init__.pyexamples/fastapi-saas/backend/app/alembic/env.pyREADMEscript.py.mako詳細
Hookdeck Outpost
送信イベント配信:プラットフォームのイベントをテナントの宛先(Webhook、キュー、クラウドバスなど。詳しくはサポート対象の宛先を参照)に公開します。GitHub でオープンソースとして公開されており、Hookdeck Cloud でのマネージド利用、またはセルフホストに対応しています。
信頼できる唯一の情報源: 概念、API、クイックスタート、UI のガイダンスについては、Hookdeck Outpost のドキュメントを参照してください。このスキルではそのドキュメントにリンクし、エージェントのワークフローに関するメモを references/ に追加しています。
API のベース URL と認証情報
マネージド版 Outpost API の URL は https://api.outpost.hookdeck.com/2025-07-01 です。api.hookdeck.com ではありません。Hookdeck のプロジェクト API キーのうち、Outpost プロジェクトに属するもので認証してください(Hookdeck ダッシュボード → ご利用の Outpost プロジェクト → Settings → Secrets)。キーはベアラートークンとして送信します。キーはサーバー側に保管してください。
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 には組織 API キーとプロジェクト API キーがあります。Outpost のサーバー側の作業ではプロジェクト API キーを使用してください。重要なのは、そのキーがどのプロジェクトに属しているかです。
Outpost 以外のプロジェクトのキーでも api.hookdeck.com に対する認証は通り、Hookdeck CLI でも使用できるため、正しいキーに見えます。しかし、ほとんどの Outpost ルートでは 404 Not Found が返されます。この 404 は「このキーは別のプロジェクトのもの」という意味であり、「このアカウントでは Outpost がプロビジョニングされていない」という意味ではありません。Outpost プロジェクトのキーをユーザーに依頼してください。api.hookdeck.com を使ってタスクを構築する方法に切り替えないでください。これは別の製品であるEvent Gatewayのものです。
エージェント向けドキュメント一覧
llms.txt: https://hookdeck.com/docs/outpost/llms.txt — ドキュメントページを.mdURL で一覧にしたプレーンテキストのマップです。全体の構成や複数のページが必要な場合に、一度取得してください。- 概念: テナント、宛先、トピック、公開
- API リファレンス: REST / OpenAPI。セルフホスト用の仕様ファイル:
https://github.com/hookdeck/outpost/blob/main/docs/apis/openapi.yaml - SDK: 概要 — TypeScript、Python、Go を使用する場合は、正しいシグネチャに従うため、各言語のクイックスタートを参照してください。
- 独自の UI の構築: ガイド — 画面のフロー、BFF パターン、実装チェックリストを紹介しています。
- 宛先/トピック: 宛先の種類 · トピックとサブスクリプション
クイックスタート(最短の手順から)
このリポジトリのフルスタックの例を開く前に、マネージド版 Outpost の公式チュートリアルを使用してください。
| curl(HTTP のみ) | Hookdeck Outpost curl クイックスタート |
| TypeScript | TypeScript クイックスタート |
| Python | Python クイックスタート |
| Go | Go クイックスタート |
コンパクトなリンク一覧:references/outpost-quickstarts.md。
テスト用 Webhook 宛先 URL(README とドキュメント)
Webhook の宛先として使い捨ての HTTPS URLが必要な場合(クイックスタート、curl の例、「配信の確認」など):
- Hookdeck Consoleを優先してください — Source を作成してその URL(例:
https://hkdk.events/…)をコピーすると、配信の確認や再実行を 1 か所で行えます。エージェントと人間のどちらにも適した、Hookdeck ネイティブの標準の方法です。
エージェント向けの最短手順
- references/outpost-scope.mdを最初に確認し、Quick path、新しい最小アプリ、既存アプリのいずれかを選びます。
- スコープが曖昧な場合は、最小のクイックスタート形式の成果物をデフォルトにします。
- 必要な言語のクイックスタート(curl、TypeScript、Python、Go)のみを取得します。
- 作業を終える前にreferences/outpost-verify.mdを確認します。
- フルスタックの例を開くのは、タスクで BFF/UI の統合パターンが明らかに必要な場合に限ります。
スコープと検証(エージェントのワークフロー)
ダッシュボード形式のガイダンス({{PLACEHOLDERS}}は含みません。これらはダッシュボードでのみ使用します):
- references/outpost-scope.md — 3 段階の選択肢、最小構成をデフォルトにする方針、言語とアーキテクチャ、トピックの調整、Building your own UIのアンカーへのリンク付きの SDK と OpenAPI / BFF の案内。
- references/outpost-verify.md — 簡潔な「作業を終える前に」チェックリスト。
BFF / wire JSON: 認証 · Wire JSON、SDK のレスポンス、UI
サポートされる宛先タイプ
利用可能: Webhooks(HTTP)、Hookdeck Event Gateway、AWS SQS、AWS Kinesis、AWS S3、Azure Service Bus、GCP Pub/Sub、RabbitMQ(AMQP)、Kafka
予定: AWS EventBridge
デプロイと API の案内
- マネージド: Hookdeck Outpost のドキュメントと言語別のクイックスタート。
- セルフホスト可能なクイックスタート: Docker、Kubernetes、Railway、設定。
- API リファレンス: Outpost REST / OpenAPI。
- ベース URL と認証: Outpost プロジェクトのプロジェクト API キーとともに
https://api.outpost.hookdeck.com/2025-07-01を使用します。API ベース URL と認証情報を参照してください。
フルスタックのリファレンス例(上級者向け)
使用するのは、現実的な BFF + ダッシュボードのパターンが必要なタスクに限ります。「最小の例」には使用せず、まずクイックスタートと**llms.txt**を確認してください。
統合マップ(ツリーを開く前に確認してください):
- Next.js:references/nextjs-saas-integration-map.md
- FastAPI:references/fastapi-saas-integration-map.md
例はそのままコピーするひな形ではなく、リファレンスとして扱ってください。 ユーザーのコードベースを優先し、Outpost 固有の動作(サーバー専用の Outpost プロジェクト API キー、テナントのマッピング、BFF ルート、ドメインのpublish)についてはマップを使用します。
| 例 | スタック | 場所 |
|---|---|---|
| SaaS(Next.js) | App Router + @hookdeck/outpost-sdk + ダッシュボード UI | examples/nextjs-saas/ — README |
| SaaS(FastAPI + React) | FastAPI BFF(httpx → Outpost)+ テンプレート UI | examples/fastapi-saas/ — README |
依存関係とバージョンの固定は、各例のマニフェスト(package.json、pyproject.toml)に記載されています。
例の使い方: まず統合マップと README の概要を読み、ユーザーのタスクに合致する場合にのみ、ほかのファイルを開いてください。
テスト: nextjs-saasでnpm test(Vitest)、fastapi-saas/backendで./scripts/test-examples.sh outpost経由でpytest test_outpost_wire.pyを実行します。Next.js の例ではnpmを使用します。
今後のスキル
宛先固有のスキル(outpost-webhooks、outpost-sqsなど)は、ドキュメントの整備に伴って追加される可能性があります。
関連スキル
- hookdeck — Hookdeck 製品向けスキルルーター
- event-gateway — Hookdeck Event Gateway(受信 Webhook)