ウォークスルー:ウェブフックイベントハンドラの作成と設定

Webhookイベントハンドラの設定フィールド

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

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

このトピックでは、ウェブフックのイベントハンドラフィールドとサポートイベントについて説明します。

Webhookイベントハンドラフィールド

ウェブフックのDataセクションとInformationセクションのフィールドを設定することで、ウェブフックイベントハンドラを設定できます。

ウェブフックイベントハンドラには、以下の設定可能なフィールドが含まれています:

フィールド	概要
Enabled	ウェブフックが有効かどうかを判定します。チェックボックスを選択すると、ウェブフックはアクティブでリクエストを送信します。チェックボックスを消すと、ウェブフックは無効化され、リクエストを送信しません。
Events	リクエストを送信するイベントを定義します。サポートイベントの一覧は「サポートされたイベント」テーブルで確認できます。イベントを選択しなければ、ウェブフックはリクエストを送信しません。
Rule	どのアイテムがリクエストをトリガーするかを指定します。ルールを追加しなければ、どのアイテムからのイベントでもリクエストが送られます。大量のリクエスト送信によるパフォーマンス低下を避けるためにルールを定義することを強くお勧めします。
Url	リクエストを受信するエンドポイントです。安全なHTTPS URLの使用を推奨します。
Serialization Type	ペイロードリクエストタイプを定義します。利用可能なフォーマットはJSONとXMLです。JSONはデフォルトで選択されています。XMLリクエストの場合、デフォルトのルート要素はeventです。
Authorization	ウェブフックの認可項目を定義します。ドロップダウンメニューには利用可能なすべての認可項目が記載されています。エンドポイントに認証が不要の場合は、このフィールドを空欄のままにしてください。
Description	ウェブフックを説明するためのオプションテキストフィールド。

支援イベント

ウェブフックイベントハンドラは、以下のシステムイベントに関する情報を送信できます:

イベント名	概要
item:added	テンプレートから新しいアイテムが追加されると上昇します。
item:versionAdded	新しいバージョンが追加されると上がります。
item:cloneAdded	新たにクローンされたアイテムが追加されると上昇します。
item:deleted	アイテムが削除されると上昇します。
item:deleting	アイテムを削除する前に上げて。
item:versionRemoved	アイテムのバージョンが削除されると上昇します。
item:locked	アイテムがロックされると上昇します。
item:unlocked	アイテムが解除されると上昇します。
item:saved	アイテム内で少なくとも1つの変更が保存されると上昇します。このイベントはUIの単純なアイテム操作中に複数回発生することがあります。
item:copied	アイテムがコピーされると上昇します。
item:moved	アイテムが別の親に移動された際に引き上げられます。
item:renamed	アイテム名が変更されると上昇します。
item:sortorderchanged	アイテムのソート順が変わると上がります。
item:templateChanged	アイテムのテンプレートが変わると上がります。
publish:begin	記事の公開開始時に提起されます。
publish:end	記事の公開終了時に提起されます。
publish:fail	アイテムの公開が失敗したときに提起されます。
publish:statusUpdated	アイテム公開のステータスが更新された際に提起されます。

この記事を改善するための提案がある場合は、お知らせください!