--- title: "ウェブフックオブジェクト" slug: "webhook-objects" abstract: "Edge Admin APIエンドポイントとやり取りするウェブフックのJSONオブジェクトで、XMおよびXM Cloudの公開フローを統合します。" --- # ウェブフックオブジェクト ウェブフックとは、サービスが他のアプリケーションにリアルタイムの情報を提供する方法です。ウェブフックは、公開操作が完了すると外部のアプリケーションビルドをトリガーします。 以下の表は、Edge Admin APIのwebhooksエンドポイントで使用されているさまざまなJSONオブジェクトを一覧にしています。 ## ウェブフック編集 CreateWebhookや[UpdateWebhook管理者エンドポイント](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html "Admin API")を呼び出す際にウェブフックを作成または更新するために使われるプロパティ。 名称 種類 概要 レーベル ストリング ウェブフックの目的を説明しています。 ウリ ウリ ウェブリクエストを出すためのURIです。 方法 ストリング ウェブリクエストを行う際に使うHTTPメソッド。 GET か POSTでなければなりません。 ヘッダー 目的 ウェブリクエストを送る際に送信するカスタムヘッダー。認証によく使われます。 ボディ ストリング ウェブリクエストをする際に投稿する本体。 ExecutionMode が OnEndの場合のみ入力されます。 本文含め ストリング ウェブフックリクエストの本文に含まれる追加の JSON オブジェクト。 ExecutionMode が OnUpdateの場合のみ入力されます。このフィールドは有効な JSON オブジェクトでなければなりません。 作成者 ストリング ウェブフックを作成したユーザーの名前です。 実行モード ストリング ウェブフックの実行方法を決定します。以下のいずれかの選択肢でなければなりません: 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" } ## ウェブフック ウェブフックについて説明しています。 名称 種類 概要 ID ストリング このウェブフックの識別子です。 tenantID ストリング このウェブフックが属するテナントの ID。 レーベル ストリング ウェブフックの目的を説明しています。 ウリ ウリ ウェブリクエストを出すためのURIです。 方法 ストリング ウェブリクエストを行う際に使うHTTPメソッド。GETかPOSTでなければなりません。 ヘッダー 目的 ウェブリクエストを送る際に送信するカスタムヘッダー。認証によく使われます。 ボディ ストリング ウェブリクエストをする際に投稿する本体。 ExecutionMode が OnEndの場合のみ入力されます。 本文含め ストリング ウェブフックリクエストの本文に含める追加のJSONオブジェクト。ExecutionModeがOnUpdateである場合にのみ入力可能です。このフィールドは有効なJSONオブジェクトでなければなりません。 作成者 ストリング ウェブフックを作成したユーザーの名前です。 創造された DateTimeOffset(日付時間オフセット) ウェブフックが作成されたタイムスタンプ。 実行モード ストリング ウェブフックの実行方法を決定します。以下のいずれかの選択肢でなければなりません: OnEnd、 OnUpdate。 最後のラン オブジェクトの配列 ウェブフックの最新の実行結果。以下の表は lastRuns オブジェクトを説明します。 ### lastRunsオブジェクト { .notintoc } lastRunsオブジェクトは以下のフィールドを含めることができます: 名称 種類 概要 タイムスタンプ DateTimeOffset(日付時間オフセット) 実行ログが作成されたタイムスタンプ。 成功 ブール ウェブフックが成功裏に実行されたかどうかを示します。 メッセージ ストリング ウェブフックが失敗した場合、エラーメッセージが表示されます。 例: { "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 } ## エンティティアップデート 更新されウェブフック実行を引き起こしたエンティティを記述します。 名称 種類 概要 識別子 ストリング エンティティの識別子。 entity\_definition ストリング エンティティが使うエンティティ定義。更新操作のためだけに埋め込まれています。 操作 ストリング 実行される操作の種類: update または delete。 例: { "identifier": "B43D07BD61D5448F93238B6ACAD4F3C4", "entity\_definition": "Item", "operation": "Update", "entity\_culture": "en" } ## WebHookRequest OnUpdate実行モードを使用するウェブフックエンドポイントに対して行われるリクエストの本文。 名称 種類 概要 invocation\_id ガイド ウェブフックの呼び出しを識別します。複数のウェブフックリクエストにまたがる大量の更新を相関させるために使用されました。 アップデート EntityUpdate の配列 更新されウェブフック実行を引き起こしたエンティティたち。 続く ブール 追加のアップデート送信継続リクエストがあるかどうかを示します。これは多数のアップデートがあり、複数のリクエストに分散されている場合に発生します。 フィールドが埋められた場合、このJSONオブジェクトはリクエストの本体に統合され、注入されるオブジェクトのプロパティが要求本体オブジェクトに取り入れられます。 例: { "invocation\_id": "6a271d7b-92de-4d14-8002-8fc97a46c290", "updates": { "identifier": "B43D07BD61D5448F93238B6ACAD4F3C4", "entity\_definition": "Item", "operation": "Update", "entity\_culture": "en" }, { "identifier": "siteName", "entity\_definition": "SiteInfo", "operation": "Update", "entity\_culture": "all" }, { "identifier": "3CE9A090FB9B42BEB593F39BFCB1DE2B", "entity\_definition": "Item", "operation": "Update", "entity\_culture": "en" } , "continues": false }