Webhook の実行モード

Current version: 4.2

Webhook は、静的サイト ジェネレーター (SSG) のサイト構築の再構築や開始など、Web アプリケーションに要求を行うために配信サービスによって提供されるメソッドです。

コンテンツ配信機能は、Webhook を実行する方法とタイミングを決定するさまざまな実行モードを実装しています。

OnEnd

[OnEnd] は、既定の実行モードです。このモードでは、キャッシュが削除された後、公開ジョブの最後に Webhook が実行されます。Webhook 定義に本文が含まれている場合は、Webhook リクエストの本文としてそのまま送信されます。Webhook 定義にカスタム ヘッダーを設定して、本文がプレーン テキスト以外 (JSON や XML など) の場合に、リクエストのコンテンツ タイプを変更できます。

Webhook エンドポイントへのリクエストは、エンドポイントへのリクエスト数を減らし、いくつかの小さな変更をスムーズにするために、デバウンスされます。

OnUpdate

[OnUpdate] は、[OnEnd] と同様に機能しますが、Webhook リクエストの本文に、Webhook を実行する原因となったエンティティの変更が含まれます。このモードでは、Webhook 定義でカスタム本文を使用できません。

大きなリクエストの送信を回避するために、エンティティの変更は複数の Webhook リクエストにわたってバッチで送信されます。各バッチは重複排除されるため、単一のリクエストで繰り返しイベントが送信されることはありません。送信される本文は JSON 形式です。JSON データを本文に含めるには、Webhook 定義の bodyInclude フィールドに値を入力します。

ヒント

リクエスト形式の詳細については、 Webhook API セクションを参照してください。

Do you have some feedback for us?

If you have suggestions for improving this article,