Webhook
一般的なユースケース
| ユースケース | 説明 |
|---|---|
| 支払い通知 | 注文の支払いが正常に完了したときに、決済プラットフォームが通知を送信します |
| 認証更新 | サードパーティのログインサービスがログイン状態を更新します |
| 非同期タスクの結果 | バックグラウンドタスクが完了時に結果を送信します |
| イベントトリガー | 特定のイベントが発生したときに、システムが外部サービスへ通知します |
通常のエンドポイントとの主な違い
Webhook エンドポイントの作成
Apidog プロジェクトで、左サイドバーの 「+」 アイコンをクリックし、「New Other Protocol APIs」 → 「Webhook」 を選択します。
Webhook を作成したら、エディターで次のフィールドを入力します。
| フィールド | 説明 |
|---|---|
| リクエストメソッド | 通常は POST です |
| Webhook 名 | API ドキュメントおよび OpenAPI エクスポートに表示されます（例: order） |
| デバッグ URL | 任意です。テストリクエストの送信に使用する実際の URL です（テスト専用で、ドキュメントには含まれません） |
| その他の情報 | リクエストボディ、ヘッダー、その他の設定 |
必須フィールドをすべて入力したら、「Save」 をクリックします。
Webhook エンドポイントのデバッグ
1.
2.
Webhook ドキュメント
デバッグ URL のプライバシー
webhooks フィールドの下に一覧表示されます。これは、通常のエンドポイントの paths フィールドとは異なります。FAQ
Modified at 2026-06-11 07:06:02