管理者Webhooks API

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

外部サービスでWebhookを実行するにはAdmin Webhooks APIを使用します。

Webhookの実行モード

ウェブフックとは、配信サービスが提供する方法で、静的サイトジェネレーター(SSG)のサイト構築の再構築や開始など、ウェブアプリケーションへのリクエストを行います。

コンテンツ配信機能は、ウェブフックの実行方法とタイミングを決定する異なる実行モードを実装しています。

OnEnd

OnEndはデフォルトの実行モードです。このモードでは、ウェブフックはキャッシュがパーグされた後、パブリッシングジョブの最後に実行されます。ウェブフックの定義に本文が含まれている場合、それはウェブフックリクエストの本文としてそのまま送信されます。ウェブフック定義にカスタムヘッダーを設定し、ボディがプレーンテキスト(JSONやXMLなど)でない場合、リクエストの内容タイプを変更することができます。

ウェブフックエンドポイントへのリクエストはデボウンス処理され、エンドポイントへのリクエスト数を減らし、いくつかの小さな変更をスムーズに処理します。

更新

OnUpdateOnEndと同じ仕組みですが、Webhookの要求の本文にWebhookを実行する原因となったエンティティの変更を含みます。このモードではWebhookの定義にカスタムボディを入れることはできません。

大規模なリクエストを送信しないため、エンティティの変更は複数のウェブフックリクエストに分けてバッチで送信されます。各バッチは重複を除去し、同じリクエストで繰り返しイベントが送信されることはありません。送信される本文はJSON形式です。ウェブフック定義のbodyIncludeフィールドを埋めることで、JSONデータを本文に含めることができます。

故障したウェブフックの自動無効化

自動無効化機能はウェブフックの実行状況を監視し、10回連続で失敗したウェブフックを無効化します。

!注ウェブフックは応答までに30秒以上かかる場合、失敗したとみなされます。

ウェブフックが実行されると、その結果はlastRunsプロパティに記録されます。実行が失敗した場合:

システムは過去の実行結果を取得し、過去9回の実行も失敗していないか確認します。
この場合、 Disabled プロパティは true に設定され、ウェブフックは自動的に無効化されます。
以下の message がlastRunsプロパティに追加されており、ウェブフックが無効化されていることを示します。 The webhook has failed the past 10 consecutive executions and is now disabled.

ウェブフックを再活性化する

必要に応じて、失敗の理由を説明した後に手動でウェブフックを再有効化することも可能です。

そのためには、/webhooks/エンドポイントにPUTリクエスト(例:/webhooks/97261f96-2b43-4e25-a925-5bc56194f1b1)を送信し、Disabledプロパティをfalseに設定します。以下の例に示されています。

{ "tenantId": "kgo-tenant", "label": "kgo webhook", "uri": "https://www.sitecore.com/", "method": "GET", "headers": { "x-header": "foo" }, "disabled": false }