ウォークスルー:ウェブフック検証アクションの追加と設定

ウェブフック検証アクションHTTPリクエスト

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

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

このトピックでは、ウェブフック検証アクションリクエストのプロパティの概要とサンプルリクエストを示します。

大事な

Webhookの検証アクションリクエストを送信すると、宛先エンドポイントはコマンドの検証応答を送らなければなりません。そうでなければ、ワークフローアクションが失敗し、アイテムの状態は変わりません。

ウェブフック検証アクションリクエストにおけるプロパティ

すべてのウェブフック検証アクションリクエストペイロードには、ウェブフックおよび発生したアクションに関する情報を提供する以下のプロパティが含まれています。

Property	価値タイプ	概要
ActionID	GUID	プロセッサのアイテムID。どのウェブフックがデータを送ったかを判定します。
ActionName	ストリング	プロセッサのアイテム名。どのウェブフックがデータを送ったかを判定します。
Comments	ストリング	コメント欄のテキスト。
DataItem	アイテム	トリガーしたウェブフックを含むアイテムです。
Message	ストリング	アクション中にエラーが発生した場合の詳細を提供します。
NextState	ワークフローステート	アイテムを移動させたい状態です。状態に送信アクションのウェブフックを挿入すると、NextState nullを返します。
PreviousState	ワークフローステート	アイテムが移動する状態。
UserName	ストリング	ワークフローアクションを開始したユーザーです。
WorkflowName	ストリング	そのアイテムが使うワークフローの名前。
WebhookItemId	GUID	イベントにサスクライブしトリガーされたウェブフックアイテムのID。
WebhookItemName	ストリング	ウェブフックのアイテム名。

JSON形式のサンプルウェブフック検証アクションリクエスト

以下はJSON形式のウェブフック検証アクションリクエストの例です。

{
  "ActionID": "a562a1b8-5c1d-4935-bd0a-41fc49ed7ded",
  "ActionName": "Sample Webhook Validation Action",
  "Comments": [
    {
      "Key": "Comments",
      "Value": "Approved!"
    }
  ],
  "DataItem": {
    "Language": "en",
    "Version": 1,
    "Id": "d1e410b9-64e7-42fb-9593-bc86ab1dd034",
    "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": [...]
  },
  "Message": "",
  "NextState": {
    "DisplayName": "Approved",
    "FinalState": true,
    "Icon": "Software/16x16/jar.png",
    "StateID": "{07A52C51-F465-4187-9E8C-68A34764F351}",
    "PreviewPublishingTargets": []
  },
  "PreviousState": {
    "DisplayName": "Awaiting approval",
    "FinalState": false,
    "Icon": "Software/16x16/jar.png",
    "StateID": "{87FEC0C1-CAE3-4272-BA58-3DF7082BD1DB}",
    "PreviewPublishingTargets": []
  },
  "UserName": "sitecore\\[email protected]",
  "WorkflowName": "Workflow with webhook",
  "WebhookItemId": "a562a1b8-5c1d-4935-bd0a-41fc49ed7ded",
  "WebhookItemName": "Sample Webhook Validation Action"
}

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