ウェブフックを作成する

POST /api/v1/eventConfigurations

ウェブフックを作成します。

リクエスト本体で、enabledの値をtrueに設定してウェブフックを有効にすることができます。ウェブフックを有効にすると、Sitecore共通監査ログはすぐにすべての監査ログをウェブフックのターゲットURLに転送し始めます。

リクエスト文には以下の必要な属性を記載する必要があります:

属性

種類

概要

例

space

ストリング

Sitecore CDP、Sitecore Connect、Sitecore Personalizeでログされた活動の場合、この値を "Production"に設定します。

Sitecore Cloud Portalで記録された活動の場合、この値を"prod"に設定します。

> [!注]
> CDP、Connect、Personalize、クラウドポータルから単一のエンドポイントへイベントを送信するには、同じウェブフックのターゲットURLを持つ2つのウェブフックを作成します。

• "Production"
• "prod"

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"

eventName

ストリング

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

この値を "sitecore.backbone.messages.audit.created"に設定しなければなりません。

"sitecore.backbone.messages.audit.created"

enabled

ブール値

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

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

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

true または false

レスポンス内のevents配列内のオブジェクトの中、idキーにはウェブフックIDが含まれています。例えば、ウェブフックの 取得 や 更新 にはウェブフックIDを使用します。

curl -X POST '/api/v1/eventConfigurations' \ -H 'Authorization: Bearer ' \ -H 'Accept: application/json' \ --data-raw ' { "space": "Development", "sourceSystem": { "$type": "AnySource" }, "destinationSystem": { "$type": "Webhook", "secret": "", "targetUrl": "https://www.exampletartget.url/example-endpoint" }, "eventName": "sitecore.backbone.messages.audit.created", "enabled": true }'

{ "events": { "id": "7050346545d5447da57b64be6416ac78", "enabled": true, "name": "sitecore.backbone.messages.audit.created", "description": null }

}