Webhook

Webhookとは、HTTP APIを利用してイベント通知を受信するための仕組みです。特定のイベントが発生した際、システムが事前に設定されたURL（Webhook URL）に対してHTTPリクエストを自動的に送信します。主に、外部システムへ状態変化や非同期タスクの結果を通知する用途で利用されます。

主な利用例：

決済プラットフォームが注文の支払い完了時に通知を送信する場合

サードパーティログインサービスがログイン状態を更新する場合

非同期タスクが完了時に結果を通知する場合

技術的にはWebhookもHTTP APIの一種ですが、利用方法に違いがあります。Webhookではシステム側が外部URLへリクエストを送信するのに対し、通常のAPIではクライアントがシステムにリクエストを送信します。

Webhook APIの作成

Apidogプロジェクト内の左サイドバーで「+」アイコンをクリックし、「新しい他の種類のAPI」＞「Webhook」を選択します。

Webhookを作成後、エディタで以下の項目を入力します。

リクエストメソッド：通常はPOSTを選択します。

Webhook名：APIドキュメントやOpenAPIエクスポート時に表示されます（例：order）。

Debug URL（任意）：テストリクエスト送信時に使用する実際のURL。注意：テスト専用であり、ドキュメントには含まれません。

その他情報：リクエストボディなど

必要事項の入力が完了したら、保存をクリックしてください。

Webhook APIのデバッグ

Webhookのデバッグでは、イベント発生をシミュレートし、外部サービスが正しくリクエストを受信できるかを検証します。

Debug URL欄にWebhook URLを入力し、送信をクリックすることで、Webhookコールを模擬できます。

Webhookのドキュメント

Webhookのドキュメントには、Webhook名、リクエストメソッド、リクエストボディなどの詳細が記載されます。これにより、特定イベント発生時にどのようなデータが送信されるかを利用者が把握しやすくなります。

Debug URLは、ドキュメントやOpenAPIエクスポートには含まれません。内部テストのみに使用されます。

エクスポートされたOpenAPIファイルでは、Webhook APIはwebhooksフィールドに記載され、通常のAPIのpathsフィールドとは区別されます。

よくある質問（FAQs）

なぜWebhookをドキュメント内で個別に定義するのですか？

OpenAPI 3.1仕様に基づき、

通常のAPIはpathsフィールドで定義されます

Webhook APIはwebhooksフィールドで定義されます

この明確な区分により、

通常のAPIは外部クライアントがデータ取得や操作のために呼び出します

Webhookはシステム側から外部サービスへ通知を行います

Apidogでは、この方向性の違いを正確に反映し、OpenAPIエクスポート時にも適切な形式となるよう、Webhookを独立したAPIタイプとして扱っています。

例：

/ordersはクライアントが利用する通常のAPIです。

orderPaidは、注文が支払われた際にシステムからトリガーされるWebhookです。

Webhookは通常のAPIと同じものですか？

Debug URLはAPIドキュメントに表示されますか？

Webhook APIの作成#

Webhook APIのデバッグ#

Webhookのドキュメント#

よくある質問（FAQs）#

Webhook APIの作成

Webhook APIのデバッグ

Webhookのドキュメント

よくある質問（FAQs）