1. 監査ログ

ウェブフックREST API

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

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

Webhook REST APIは、サポートされたすべてのSitecore DXPアプリケーションから、すべての監査ログをSitecore外のシステムに転送できます。例えば、セキュリティ情報・イベント管理(SIEM)システムへと転送し、そこで記録された監査ログを分析できます。

すべての監査ログを転送し始めるには、ウェブフック を作成して有効化 できます。少なくとも1つのウェブフックを作成した後、他のAPIエンドポイントを呼び出して、例えばウェブフックの 更新 や 無効 化を行えます。

ベースURL

一般的に、Webhook REST API基本URLはSitecoreインスタンスの地域によって異なります。

唯一の例外は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 > 会社情報 > 環境をクリックしてください:
    • 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 >」をクリックしてください:
    • APリージョン とは、あなたのSitecoreリージョンが AUEであることを意味します。
    • EU地域 とは、あなたのSitecore地域が EUWであることを意味します。
    • USリージョン とは、あなたのSitecoreリージョンが USEであることを意味します。

認証

Webhook REST APIベアラー認証を使用します。

ベアラー認証は、すべてのリクエストにベアラートークンを送信することを意味します。ベアラートークンにアクセスできるのは、Organization AdminまたはOrganization Ownerの役割を持つユーザーだけです。ベアラートークンにアクセスするには、Sitecore Cloud Portalにログインし、メニューバーの右上でプロフィール 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に転送され始めます。

ウェブフック作成後にこれを変更するには、「 ウェブフックを無効にする 」と「 ウェブフックを有効にする」を参照してください。

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ユーザーのメールアドレスです。

"[email protected]"

createdDate

文字列(ISO 8601)

ウェブフックが作成されたUTCの日付と時刻。

"2026-01-08 08:06

"

updatedBy

ストリング

ウェブフックを最後に更新したユーザーの一意識別子。

"[email protected]"

updatedDate

文字列(ISO 8601)

ウェブフックが最後に更新されたUTC日時。

"2026-01-16 11:03

"

eventName および name

ストリング

ウェブフックが作成される内部イベント名。

"sitecore.backbone.messages.audit.created"

enabled

ブール値

作成時にウェブフックが有効または無効化されるかを決定します。

有効化されると、ログは即座にウェブフックのターゲットURLに転送され始めます。

true または false

応答コード

Webhook REST APIは、リクエストの結果を知らせるために標準的なHTTP応答を使用します。

HTTP応答

概要

200 OK

Webhookが正常に回収されました。

201 Created

Webhookが無事に作成されました。

401 Unauthorized

あなたはリソースへのアクセス権限を持っていません。 有効なベアラートークンを使うことを忘れないでください。

404 Not Found

ウェブフックが見つかりません。

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