Webhookイベント ハンドラーの構成フィールド
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
このトピックでは、Webhookイベント ハンドラーのフィールドとサポートされているイベントについて説明します。
Webhookイベント ハンドラー フィールド
Webhookイベント ハンドラー フィールド
Webhookイベント ハンドラーを構成するには、WebhookのDataセクションとInformationセクションのフィールドを構成します。
Webhookイベント ハンドラーには、次の構成可能なフィールドが含まれています。
|
畑 |
形容 |
|---|---|
|
Enabled |
Webhookが有効になっているかどうかを判断します。このチェックボックスをオンにすると、Webhookがアクティブになり、リクエストが送信されます。このチェックボックスをオフにすると、Webhookは無効になり、リクエストは送信されません。 |
|
Events |
要求を送信するイベントを定義します。サポートされているイベントのリストは、サポートされているイベントの表にあります。イベントを選択しない場合、Webhookはリクエストを送信しません。 |
|
Rule |
リクエストをトリガーするアイテムを指定します。ルールを追加しない場合、任意のアイテムのイベントからリクエストが送信されます。 大量のリクエストを送信することによるパフォーマンスの低下を避けるために、ルールを定義することを強くお勧めします。 |
|
Url |
要求を受信するエンドポイント。安全なHTTPS URLを使用することをお勧めします。 |
|
Serialization Type |
ペイロード要求の種類を定義します。使用可能な形式はJSONとXMLです。デフォルトではJSONが選択されています。XML要求の場合、デフォルトのルート要素はeventです。 |
|
Authorization |
Webhookの認証項目を定義します。ドロップダウンメニューには、使用可能なすべての認証項目が含まれています。エンドポイントが認証を必要としない場合は、このフィールドを空白のままにします。 |
|
Description |
Webhookを説明するオプションのテキスト フィールド。 |
サポートされているイベント
サポートされているイベント
Webhookイベントハンドラは、次のシステムイベントに関する情報を送信できます。
|
イベント名 |
形容 |
|---|---|
|
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 |
アイテムの公開ステータスが更新されたときに発生します。 |