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

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

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

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

フィールド

概要

Enabled

ウェブフックが有効かどうかを判定します。チェックボックスを選択すると、ウェブフックはアクティブでリクエストを送信します。チェックボックスをクリアすると、ウェブフックは無効化され、リクエストを送信しません。

Events

リクエストを送信するイベントを定義します。サポートイベントのリストは 「サポートされたイベント」テーブルで確認できます。イベントを選択しなければ、ウェブフックはリクエストを送信しません。

Rule

どのアイテムがリクエストをトリガーするかを指定します。ルールを追加しなければ、任意のアイテムからのイベントがリクエストを送信します。

大量のリクエスト送信によるパフォーマンス低下を避けるためにルールを定義することを強くお勧めします。

Url

リクエストを受信するエンドポイントです。安全なHTTPSのURLを使用することを推奨します。

Serialization Type

ペイロードリクエストタイプを定義します。利用可能なフォーマットはJSONとXMLです。JSONはデフォルトで選択されます。XMLリクエストの場合、デフォルトのルート要素は eventです。

Authorization

ウェブフックの認可項目を定義します。ドロップダウンメニューには利用可能なすべての認可項目が表示されます。エンドポイントが認証を必要としない場合は、このフィールドは空欄のままにしてください。

Description

ウェブフックを説明するためのオプションテキストフィールド。

支援イベント

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

イベント名

概要

item

テンプレートから新しいアイテムが追加されると上昇します。

item

新しいバージョンが追加されると上がります。

item

新たにクローンされたアイテムが追加されると上昇します。

item

アイテムが削除されると上昇します。

item

アイテムを削除する前に上げて。

item

アイテムのバージョンが削除されると上昇します。

item

アイテムがロックされると上昇します。

item

アイテムが解除されると上昇します。

item

アイテム内で少なくとも1つの変更が保存されると発生します。このイベントはUIの簡単なアイテム操作中に複数回発生することがあります。

item

アイテムがコピーされると上昇します。

item

アイテムが別の親に移動された際に引き上げられます。

item

アイテム名が変更されると上昇します。

item

アイテムのソート順が変わると上がります。

item

アイテムのテンプレートが変わると上がります。

publish

記事の公開開始時に提起されます。

publish

記事の公開終了時に提起されます。

publish

アイテムの公開が失敗したときに提起されます。

publish

アイテム公開のステータスが更新された際に提起されます。