Experience Edgeコネクタ

Webhookオブジェクト

Version:

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

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

Webhookは、サービスが他のアプリケーションにリアルタイムの情報を提供する方法です。Webhookは、公開操作が完了したときに、使用するアプリケーションの外部ビルドをトリガーします。

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

ウェブフック編集

CreateWebhook またはUpdateWebhook Adminエンドポイントを呼び出すときに、Webhookを作成または更新するために使用されるプロパティ。

名前	種類	形容
ラベル	糸	Webhookの目的について説明します。
ウリ	ウリ	Webリクエストを行うURI。
方式	糸	Webリクエストを行うときに使用するHTTPメソッド。 GETまたはPOSTである必要があります。
ヘッダー	オブジェクト	Webリクエストを行うときに送信するカスタムヘッダー。一般的に認証に使用されます。
体	糸	Webリクエストを行うときに投稿する本文。 ExecutionModeがOnEndの場合にのみ入力されます。
body含める	糸	Webhookリクエストの本文に含める追加のJSONオブジェクト。 ExecutionModeがOnUpdateの場合にのみ入力されます。このフィールドは有効なJSONオブジェクトである必要があります。
作成者	糸	Webhookを作成したユーザーの名前。
実行モード	糸	Webhookの実行方法を決定します。次のいずれかのオプションである必要があります: OnEnd、OnUpdate。

例：

{
  "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が属するテナントのID。
ラベル	糸	Webhookの目的について説明します。
ウリ	ウリ	Webリクエストを行うURI。
方式	糸	Webリクエストを行うときに使用するHTTPメソッド。GETまたはPOSTである必要があります。
ヘッダー	オブジェクト	Webリクエストを行うときに送信するカスタムヘッダー。一般的に認証に使用されます。
体	糸	Webリクエストを行うときに投稿する本文。 ExecutionModeがOnEndの場合にのみ入力されます。
body含める	糸	Webhookリクエストの本文に含める追加のJSONオブジェクト。ExecutionModeがOnUpdateの場合にのみ設定できます。このフィールドは有効なJSONオブジェクトである必要があります。
作成者	糸	Webhookを作成したユーザーの名前。
作成	日時オフセット	Webhookが作成されたときのタイムスタンプ。
実行モード	糸	Webhookの実行方法を決定します。次のいずれかのオプションである必要があります: OnEnd、OnUpdate。
ラストラン	オブジェクトの配列	Webhookの最新の実行中の結果。次の表では、lastRunsオブジェクトについて説明します。

lastRunsオブジェクト

lastRunsオブジェクトには、次のフィールドを含めることができます。

名前	種類	形容
タイムスタンプ	日時オフセット	実行ログが作成されたときのタイムスタンプ。
成功	ブーリアン	Webhookが正常に実行されたかどうかを示します。
メッセージ	糸	Webhookが失敗した場合は、エラーメッセージが表示されます。

例：

{
  "id": "5678",
  "tenantId": "acme-corp",
  "label": "webhook 29",
  "uri": "https://www.acme.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",
  "lastRuns": [
    {
      "timestamp": "2024-05-16T10:10:53.825Z",
      "success": true
    },
    {
        "timestamp": "2024-05-30T09:50:53.2134315+00:00",
        "success": false,
        "message": "Internal service error"
    }
  ],
  "disabled": false
}

エンティティ更新

更新され、Webhookの実行を引き起こしたエンティティについて説明します。

名前	種類	形容
識別子	糸	エンティティの識別子。
entity_definition	糸	エンティティが使用するエンティティ定義。更新操作の場合にのみ入力されます。
操作	糸	実行される操作のタイプ: updateまたはdelete。

例：

{
  "identifier": "B43D07BD61D5448F93238B6ACAD4F3C4",
  "entity_definition": "Item",
  "operation": "Update",
  "entity_culture": "en"
}

WebHookリクエスト

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

名前	種類	形容
invocation_id	GUIDの	Webhookの呼び出しを識別します。複数のWebhook要求にまたがる大量の更新を関連付けるために使用されます。
最新情報	EntityUpdateの配列	更新され、Webhookの実行を引き起こしたエンティティ。
続けて	ブール値	さらに更新を送信し続けるための追加の要求があるかどうかを示します。これは、多数の更新があり、それらが複数の要求に分割されている場合に発生します。フィールドが入力されている場合、このJSONオブジェクトは要求の本文にマージされ、オブジェクトのプロパティが要求本文オブジェクトに挿入されます。

名前

種類

形容

invocation_id

GUIDの

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