チュートリアル: Webhookイベントハンドラーの作成と構成

Webhookイベントハンドラー HTTP要求

Version:

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

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

このトピックでは、Webhookイベントハンドラー要求のプロパティの概要を説明し、サンプル要求を示します。

Webhookイベントハンドラーの共通プロパティ

Webhookイベントハンドラー要求ペイロードには、Webhookアイテムと発生したイベントを識別する次のプロパティが含まれています。

財産	値の種類	形容
EventName	糸	XPのイベント名 .
WebhookItemId	GUIDの	イベントをサブスクライブし、トリガーされたWebhookアイテムのID。
WebhookItemName	糸	Webhookアイテムの名前。

イベント固有のプロパティ

各イベントには、イベント固有のプロパティが含まれています。次の表では、イベント固有のプロパティと、同じプロパティを共有するイベントが同じ行にグループ化されているイベントについて説明します。

イベント名	財産	値の種類	形容
item:added item:versionAdded item:cloneAdded item:locked item:unlocked item:versionRemoved item:deleting	Item	アイテム	影響を受けるアイテム。
item:deleted	Item	アイテム	影響を受けるアイテム。
item:deleted	ParentID	グイド	削除された項目の親ID。
item:saved	Item	アイテム	保存したアイテム。
item:saved	Changes	アイテムの変更	アイテムに加えられた変更に関する情報。
item:copied	Source	アイテム	元のアイテム。
item:copied	Copy	アイテム	元のアイテムのコピー。
item:moved	Item	アイテム	移動したアイテム。
item:moved	OldParentID	グイド	アイテムの前の親。
item:renamed	Item	アイテム	名前が変更されたアイテム。
item:renamed	OldName	糸	アイテムの古い名前。
item:sortorderchanged	Item	アイテム	影響を受けるアイテム。
item:sortorderchanged	OldValue	糸	前の項目の並べ替え順序。
item:templateChanged	Item	アイテム	影響を受けるアイテム。
item:templateChanged	TemplateChanges	テンプレートの変更	アイテムのテンプレートに加えられた変更に関する情報。
publish:begin publish:end	PublisherOptions	パブリッシャーオプション	基本的な公開情報。
publish:statusUpdated	Status	ステータス変更	進行状況情報を公開します。
publish:fail	PublisherOptions	パブリッシャーオプション	基本的な公開情報。
publish:fail	Exception	例外	公開の試行中に発生した例外に関する情報。

JSON形式のWebhookイベントハンドラリクエストのサンプル

次に、項目が追加されたことを通知するJSON形式のWebhookイベントハンドラー要求の例を示します。

{
  "EventName": "item:added",
  "Item": {
    "Language": "en",
    "Version": 1,
    "Id": "4c3a401e-8b78-440a-bf88-736a71ce8e5a",
    "Name": "New sample item",
    "ParentId": "8fb31904-1bbc-463c-821b-c7c1a87bf13e",
    "TemplateId": "0133f52d-271f-4217-b1cd-04342e3457eb",
    "TemplateName": "Sample Item",
    "MasterId": "00000000-0000-0000-0000-000000000000",
    "SharedFields": [
      {
        "Id": "a4f985d9-98b3-4b52-aaaf-4344f6e747c6",
        "Value": "{88AD1387-D4DA-489D-BB4B-45540917E7ED}"
      }
    ],
    "UnversionedFields": [],
    "VersionedFields": [...]
  },
  "WebhookItemId": "95398c44-f232-41a8-b947-8aefec4ce6eb",
  "WebhookItemName": "Sample Webhook Event Handler"
}

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

Webhookイベント ハンドラー HTTP要求

Webhookイベント ハンドラーの共通プロパティ

イベント固有のプロパティ

JSON形式のWebhookイベントハンドラリクエストのサンプル

Webhookイベントハンドラー HTTP要求

Webhookイベントハンドラーの共通プロパティ