Webhook オブジェクト

Version: 20.x
日本語翻訳に関する免責事項

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

Webhook は、サービスが他のアプリケーションにリアルタイムの情報を提供する方法です。Webhook は、パブリッシュ操作が完了すると、消費アプリケーションの外部ビルドをトリガーします。

次の表に、Edge Admin API の Webhook エンドポイント内で使用されるさまざまな JSON オブジェクトを示します。

WebhookEdit

Webhook を編集します。Webhook の作成または更新に使用されるデータです。

名前

説明

label

文字列

Webhook の目的について説明します。

uri

URI

Web 要求を行う URI。

method

文字列

Web 要求を行うときに使用する HTTP メソッド。GET または POST である必要があります。

ヘッダー

オブジェクト

Web 要求を行うときに送信するカスタム ヘッダー。一般的に認証に使用されます。

本文

文字列

Web 要求を行うときに投稿する本文。ExecutionModeOnEnd の場合にのみ指定されます。

bodyInclude

文字列

Webhook 要求の本文に含める追加の JSON オブジェクト。ExecutionModeOnUpdate の場合にのみ指定されます。このフィールドは有効な JSON オブジェクトである必要があります。

CreatedBy

文字列

Webhook を作成したユーザーの名前。

executionMode

文字列

Webhook が実行されるかどうかを決定します。オプション OnEnd または OnUpdate のいずれかである必要があります。

例:

RequestResponse
{
  "label": "My new webhook",
  "uri": "https://www.mysite.com/hooks/edge-hook",
  "method": "POST",
  "headers": {
    "x-header": "bar"
  },
  "body": "{\"rebuild\":\"true\"}",
  "createdBy": "anco",
  "executionMode": "OnEnd"
}

Webhook

Webhook について説明します。

名前

説明

id

文字列

この Webhook を識別するために使用される識別子。

tenantId

文字列

この Webhook が属するテナントの ID。

label

文字列

Webhook の目的について説明します。

uri

URI

Web 要求を行う URI。

method

文字列

Web 要求を行うときに使用する HTTP メソッド。GET または POST である必要があります。

ヘッダー

オブジェクト

Web 要求を行うときに送信するカスタム ヘッダー。一般的に認証に使用されます。

本文

文字列

Web 要求を行うときに投稿する本文。ExecutionModeOnEnd の場合にのみ指定されます。

bodyInclude

文字列

Webhook 要求の本文に含める追加の JSON オブジェクト。ExecutionMode が OnUpdate の場合にのみ指定できます。このフィールドは有効な JSON オブジェクトである必要があります。

CreatedBy

文字列

Webhook を作成したユーザーの名前。

created

DateTimeOffset

Webhook が作成されたときのタイムスタンプ。

executionMode

文字列

Webhook が実行されるかどうかを決定します。オプション OnEnd または OnUpdate のいずれかである必要があります。

例:

RequestResponse
{
  "id": "5678",
  "tenantId": "target-corp",
  "label": "webhook 29",
  "uri": "https://www.target-domain-of-the-webhook.com/hooks/edge-hook",
  "method": "POST",
  "headers": {
    "x-header": "bar"
  },
  "body": "{\"rebuild\":\"true\"}",
  "createdBy": "anco",
  "created": "2021-03-26T10:44:04.6107312+00:00",
  "executionMode": "OnEnd"
}

EntityUpdate

更新され、Webhook を実行する原因となったエンティティについて説明します。

名前

説明

identifier

文字列

エンティティの識別子。

entity_definition

文字列

エンティティが使用するエンティティ定義。update 操作の場合にのみ指定されます。

operation

文字列

実行される操作のタイプ。update または delete です。

例:

RequestResponse
{
  "identifier": "M.Setting.CleanerInterval",
  "entity_definition": "M.Setting",
  "operation": "update"
}

WebHookRequest

OnUpdate 実行モードを使用する Webhook エンドポイントに対して行われる要求の本文。

名前

説明

invocation_id

GUID

Webhook の呼び出しを識別します。複数の Webhook 要求にまたがる多数の更新を相互に関連付けるために使用されます。

updates

EntityUpdate の配列

更新され、Webhook を実行する原因となったエンティティ。

continues

ブール値

さらに更新を送信し続けるための追加の要求があるかどうかを示します。これは、多数の更新があり、それらが複数の要求に分割されている場合に発生します。

フィールドに値が指定されている場合、この JSON オブジェクトは要求の本文にマージされ、オブジェクトのプロパティが要求の本文オブジェクトに挿入されます。

例:

RequestResponse
{
  "invocation_id": "7734f16b-1e46-4321-a40e-522255d6c17a",
  "updates": [
    {
      "identifier": "M.Setting.CleanerInterval",
      "entity_definition": "M.Setting",
      "operation": "update"
    },
    {
      "identifier": "Content.PowerFromWithin",
      "operation": "delete"
    }
  ],
  "continues": false
}

何かフィードバックはありますか?

この記事を改善するための提案がある場合は、