WebhookのREST API

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

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

Webhook REST APIを使用すると、サポートされているすべてのSitecore DXPアプリケーションのすべての監査ログをSitecore外部のシステムに転送できます。たとえば、セキュリティ情報およびイベント管理 (SIEM) システムでは、記録された監査ログを分析できます。

すべての監査ログの転送を開始するには、Webhookを作成して有効にします。少なくとも1つのWebhookを作成した後、他のAPIエンドポイントを呼び出して、Webhookを更新または無効にすることができます。

ベースURL

メモ

Sitecore Cloud Portalのログ記録されたアクティビティの場合は、https://mesh-rest-api-euw.sitecorecloud.io

Webhook REST APIベースURLは、Sitecoreインスタンスのリージョンによって異なります。

Sitecore地域	Webhook REST APIベースURL
AUE	https://mesh-management-api-aue.sitecorecloud.io
EUW	https://mesh-management-api-euw.sitecorecloud.io
JPE	https://mesh-management-api-jpe.sitecorecloud.io
USE	https://mesh-management-api-use.sitecorecloud.io
USW	https://mesh-management-api-usw.sitecorecloud.io

Sitecore地域

Common Audit LogでサポートされているSitecoreDXPアプリのいずれかにログインすることで、Sitecore地域を見つけることができます。

Sitecore CDPで、メニューバーの > Company information > Environmentをクリックします。
- AP regionは、Sitecore地域がAUEであることを意味します。
- EU regionは、Sitecore地域がEUWであることを意味します。
- US regionは、Sitecore地域がUSEであることを意味します。
Sitecore Connectのメニューバーで、テナント名の最後の部分:
- Australia (East) は、Sitecore地域がAUEであることを意味します。
- Europe (West) は、Sitecore地域がEUWであることを意味します。
- Japan (East) は、Sitecore地域がJPEであることを意味します。
- US Eastは、Sitecore地域がUSEであることを意味します。
- US Westは、Sitecore地域がUSWであることを意味します。
Sitecore Personalizeで、メニューバーの > Company information > Environmentをクリックします。
- AP regionは、Sitecore地域がAUEであることを意味します。
- EU regionは、Sitecore地域がEUWであることを意味します。
- US regionは、Sitecore地域がUSEであることを意味します。

認証

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

ベアラー認証では、リクエストごとにベアラートークンを送信します。 Organization AdminまたはOrganization Ownerロールを持つチームメンバーのみがベアラートークンにアクセスできます。ベアラートークンにアクセスするには、Sitecore Cloud Portalにログインし、メニューバーの右上隅にあるプロフィール > API tokensをクリックします。ベアラートークンはBearer tokenフィールドにあります。

大事な

ベアラートークンは15分で期限切れになります。リクエストが予期せずステータス401 Unauthorizedのレスポンスを返す場合は、API tokensページを更新して新しいベアラートークンにアクセスします。

Webhookデータモデル

Webhook REST APIにリクエストを行うときは、次のWebhook属性を使用します。

属性	種類	形容	使用例
space	糸	Webhookを使用している環境。これは、ユーザーが選択できる値です。	"Development" "Production" "QA"
sourceSystem.$type	糸	ログを転送するためのSitecoreデジタルエクスペリエンスプラットフォーム(DXP)アプリ。この値は "AnySource"に設定する必要があります。これは、すべてのアプリからのログが転送されることを意味します。	"AnySource"
destinationSystem.$type	糸	ログの転送先となるシステムのタイプ。この値は "Webhook"に設定する必要があります。	"Webhook"
destinationSystem.secret	糸	Webhookターゲットのシークレット。この値は、Webhookターゲットが呼び出されたときに、X-Secret要求ヘッダーに自動的に渡されます。	該当なし
destinationSystem.targetUrl	糸	WebhookターゲットURL。これは、ログの転送先のURLです。	"https://www.exampletarget.url/example-endpoint"
logLevel	糸	Webhookメッセージを外部システムに送信しなかった場合、またはメッセージが正常に送信された場合にのみ記録します。	次のいずれかである必要があります。 "All" "FailuresOnly"
eventName	糸	Webhookが作成されたときの内部イベント名。この値は "sitecore.backbone.messages.audit.created"に設定する必要があります。	"sitecore.backbone.messages.audit.created"
enabled	ブーリアン	Webhookが作成時に有効か無効かを決定します。有効にすると、ログはすぐにWebhookターゲットURLに転送され始めます。 Webhookの作成後にこれを変更するには、「 Webhookの無効化」および「 Webhookの有効化」を参照してください。	true又は false

Webhook REST APIから応答を受信すると、次のWebhook属性が返されます。

属性	種類	形容	使用例
id	糸	Webhook ID。	"7050346545d5447da57b64be6416ac78"
organizationId	糸	組織のID。	"org_ZiiCnzhCeHDpWJAU"
sourceSystem.$type	糸	ログを転送するためのSitecoreデジタルエクスペリエンスプラットフォーム(DXP)アプリ。	"AnySource"
destinationSystem.$type	糸	ログの転送先となるシステムのタイプ。	"Webhook"
destinationSystem.secret	糸	Webhookターゲットのシークレット。この値は、Webhookターゲットが呼び出されたときに、X-Secret要求ヘッダーに自動的に渡されます。	該当なし
destinationSystem.targetUrl	糸	WebhookターゲットURL。これは、ログの転送先のURLです。	"https://www.exampletarget.url/example-endpoint"
logLevel	糸	Webhookメッセージを外部システムに送信しなかった場合、またはメッセージが正常に送信された場合にのみ記録します。	次のいずれかである必要があります。 "All" "FailuresOnly"
space	糸	Webhookを使用している環境。これは、ユーザーが選択できる値です。	"Development" "Production" "QA"
createdBy	糸	Webhookを作成したSitecore Cloud Portalユーザーのメールアドレス。	"[email protected]"
createdDate	文字列 (ISO 8601)	Webhookが作成されたUTCの日時。	"2025-01-08 08:06:12"
updatedBy	糸	Webhookを最後に更新したユーザーの一意の識別子。	"[email protected]"
updatedDate	文字列 (ISO 8601)	Webhookが最後に更新されたUTCの日時。	"2025-01-16 11:03:44"
eventNameそして name	糸	Webhookが作成されたときの内部イベント名。	"sitecore.backbone.messages.audit.created"
enabled	ブーリアン	Webhookが作成時に有効か無効かを決定します。有効にすると、ログはすぐにWebhookターゲットURLに転送され始めます。	true又は false

レスポンスコード

Webhook REST APIは、標準のHTTP応答を使用して、リクエストの結果を通知します。

HTTP応答	形容
200 OK	Webhookが正常に取得されました。
201 Created	Webhookが正常に作成されました。
401 Unauthorized	リソースにアクセスする権限がありません。有効なベアラートークンを使用していることを確認してください。
404 Not Found	Webhookが見つかりません。

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