--- title: "ウェブフックREST API" slug: "webhook-rest-api" abstract: "Webhook REST APIを使って、SitecoreCommon Audit Logからすべての監査ログ(ベースURL、認証、JSONフィールドを含む)を転送するウェブフックを作成する方法を理解しましょう。" --- # ウェブフックREST API Webhook REST APIは、サポートされたすべてのSitecore DXPアプリケーションから、すべての監査ログをSitecore外のシステムに転送できます。例えば、セキュリティ情報・イベント管理(SIEM)システムへと転送し、そこで記録された監査ログを分析できます。 すべての監査ログを転送し始めるには、ウェブフック [を作成して有効化](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/sitecore-common-audit-log/webhook-rest-api/create-a-webhook.html "Create a webhook") できます。少なくとも1つのウェブフックを作成した後、他のAPIエンドポイントを呼び出して、例えばウェブフックの [更新](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/sitecore-common-audit-log/webhook-rest-api/update-a-webhook.html "Update a webhook") や [無効](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/sitecore-common-audit-log/webhook-rest-api/disable-a-webhook.html "Disable a webhook") 化を行えます。 ## ベースURL 一般的に、Webhook REST API基本URLは[Sitecoreインスタンスの地域](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/sitecore-common-audit-log/webhook-rest-api.html#UUID-f7f4b3d3-d86a-364c-1dd1-9a179d658100_N1708525788739 "Your Sitecore region")によって異なります。 唯一の例外は[Sitecore Cloud Portal内のログされたアクティビティ](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/sitecore-common-audit-log/logged-activities/logged-activities-in-the-sitecore-cloud-portal.html "Logged activities in the Sitecore Cloud Portal")で、常にEUW領域(https://mesh-management-api-euw.sitecorecloud.io)を使用します。 Sitecore地域 ウェブフックREST API基本URL **AUE** https://mesh-management-api-aue.sitecorecloud.io **うわっ** https://mesh-management-api-euw.sitecorecloud.io **JPE** https://mesh-management-api-jpe.sitecorecloud.io **用途** https://mesh-management-api-use.sitecorecloud.io **USW** https://mesh-management-api-usw.sitecorecloud.io ### あなたのSitecoreリージョン 共通監査ログでサポートされているSitecore DXPアプリにログインすることで、あなたのSitecore地域を見つけることができます。 - Sitecore CDPでは、メニューバーで ![cdp\_gear\_icon.png](https://doc.sitecore.com/api/markdown-image/portal/ja/developers/sitecore-cloud-portal/images/cdp_gear_icon.png) > **会社情報** > **環境**をクリックしてください: - **APリージョン** とは、あなたのSitecoreリージョンが **AUE**であることを意味します。 - **EU地域** とは、あなたのSitecore地域が **EUW**であることを意味します。 - **USリージョン** とは、あなたのSitecoreリージョンが **USE**であることを意味します。 - Sitecore Connectでは、メニューバーのテナント名の最後の部分に: - **オーストラリア(東** )とは、あなたのSitecore地域が **AUE**であることを意味します。 - **ヨーロッパ(西)とは** 、あなたのSitecore地域が **EUW**であることを意味します。 - **日本(東)とは** 、あなたのSitecore地域が **JPE**であることを意味します。 - **US East** とは、あなたのSitecore地域が **USE**であることを意味します。 - **US West** とは、あなたのSitecore地域が **USW**であることを意味します。 - Sitecore Personalizeでは、メニューバーで「**会社情報**\>**環境**![cdp\_gear\_icon.png](https://doc.sitecore.com/api/markdown-image/portal/ja/developers/sitecore-cloud-portal/images/cdp_gear_icon.png) >」をクリックしてください: - **APリージョン** とは、あなたのSitecoreリージョンが **AUE**であることを意味します。 - **EU地域** とは、あなたのSitecore地域が **EUW**であることを意味します。 - **USリージョン** とは、あなたのSitecoreリージョンが **USE**であることを意味します。 ## 認証 Webhook REST APIベアラー認証を使用します。 ベアラー認証は、すべてのリクエストにベアラートークンを送信することを意味します。ベアラートークンにアクセスできるのは、*Organization Admin*または*Organization Owner*の役割を持つユーザーだけです。ベアラートークンにアクセスするには、Sitecore Cloud Portalにログインし、メニューバーの右上でプロフィール **![profile.PNG](https://doc.sitecore.com/api/markdown-image/portal/ja/developers/sitecore-cloud-portal/images/profile.PNG) > APIトークン**をクリックしてください。ベアラートークンは**ベアラートークン**フィールドにあります。 > !重要ベアラートークンは15分後に期限切れです。もしリクエストが予期せずステータス401 Unauthorizedの返答を返した場合は、**APIトークン** ページをリフレッシュして新しいベアラートークンにアクセスしてください。 ## Webhookデータモデル Webhook REST APIにリクエストを出す際、以下のウェブフック属性を扱います: 属性 種類 概要 例 space ストリング ウェブフックを使っている環境です。これはあなたの選択による値です。 - "Development" - "Production" - "QA" sourceSystem.$type ストリング ログを転送するためのSitecoreデジタルエクスペリエンスプラットフォーム(DXP)アプリ。 この値を "AnySource"に設定しなければならず、これはすべてのアプリからのログが転送されることを意味します。 "AnySource" destinationSystem.$type ストリング ログが転送されるシステムの種類。 この値を "Webhook"に設定しなければなりません。 "Webhook" destinationSystem.secret ストリング あなたが定義した秘密は、 X-Secret リクエストヘッダーで自動的に渡されます。受信するウェブフックコールを認証するには、ターゲットアプリケーションがこの秘密を検証しなければなりません。 "mys3cr3tstr1ingforauth1!x" destinationSystem.targetUrl ストリング ウェブフックのターゲットURL。これがログが転送されるURLです。 "https://www.exampletarget.url/example-endpoint" logLevel ストリング ウェブフックメッセージが外部システムに送信されなかった場合、またはメッセージが正常送信された場合にのみ記録してください。 以下のいずれかでなければなりません: - "All" - "FailuresOnly" eventName ストリング ウェブフックが作成される内部イベント名。 この値を "sitecore.backbone.messages.audit.created"に設定しなければなりません。 "sitecore.backbone.messages.audit.created" enabled ブール値 作成時にウェブフックが有効または無効化されるかを決定します。 有効化されると、ログは即座にウェブフックのターゲットURLに転送され始めます。 ウェブフック作成後にこれを変更するには、「 [ウェブフックを無効にする](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/sitecore-common-audit-log/webhook-rest-api/disable-a-webhook.html) 」と「 [ウェブフックを有効にする](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/sitecore-common-audit-log/webhook-rest-api/enable-a-webhook.html)」を参照してください。 true または false Webhook REST APIからの応答を受けると、以下のwebhook属性が返されます: 属性 種類 概要 例 id ストリング ウェブフックのID。 "7050346545d5447da57b64be6416ac78" organizationId ストリング あなたの組織のIDです。 "org\_ZiiCnzhCeHDpWJAU" sourceSystem.$type ストリング ログを転送するためのSitecoreデジタルエクスペリエンスプラットフォーム(DXP)アプリ。 "AnySource" destinationSystem.$type ストリング ログが転送されるシステムの種類。 "Webhook" destinationSystem.secret ストリング あなたが定義した秘密は、 X-Secret リクエストヘッダーで自動的に渡されます。受信するウェブフックコールを認証するには、ターゲットアプリケーションがこの秘密を検証しなければなりません。 "mys3cr3tstr1ingforauth1!x" destinationSystem.targetUrl ストリング ウェブフックのターゲットURL。これがログが転送されるURLです。 "https://www.exampletarget.url/example-endpoint" logLevel ストリング ウェブフックメッセージが外部システムに送信されなかった場合、またはメッセージが正常送信された場合にのみ記録してください。 以下のいずれかでなければなりません: - "All" - "FailuresOnly" space ストリング ウェブフックを使っている環境です。これはあなたの選択による値です。 - "Development" - "Production" - "QA" createdBy ストリング ウェブフックを作成したSitecore Cloud Portalユーザーのメールアドレスです。 "jane.doe@myretailsite.com" createdDate 文字列([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) ウェブフックが作成されたUTCの日付と時刻。 "2026-01-08 08:06:12" updatedBy ストリング ウェブフックを最後に更新したユーザーの一意識別子。 "john.doe@myretailsite.com" updatedDate 文字列([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) ウェブフックが最後に更新されたUTC日時。 "2026-01-16 11:03:44" eventName および name ストリング ウェブフックが作成される内部イベント名。 "sitecore.backbone.messages.audit.created" enabled ブール値 作成時にウェブフックが有効または無効化されるかを決定します。 有効化されると、ログは即座にウェブフックのターゲットURLに転送され始めます。 true または false ## 応答コード Webhook REST APIは、リクエストの結果を知らせるために標準的なHTTP応答を使用します。 HTTP応答 概要 200 OK Webhookが正常に回収されました。 201 Created Webhookが無事に作成されました。 401 Unauthorized あなたはリソースへのアクセス権限を持っていません。 [有効なベアラートークン](https://doc.sitecore.com/portal/ja/developers/sitecore-cloud-portal/sitecore-common-audit-log/webhook-rest-api.html#UUID-f7f4b3d3-d86a-364c-1dd1-9a179d658100_section-idm1903409955372724)を使うことを忘れないでください。 404 Not Found ウェブフックが見つかりません。