WebhookのREST API

Webhookを作成する

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

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

POST /api/v1/eventConfigurations

Webhookを作成します。

要求本文で、enabledの値をtrueに設定することで、Webhookを有効にできます。Webhookを有効にすると、Sitecore Common Audit Logはすぐにすべての監査ログをWebhookターゲットURLに転送し始めます。

要求本文には、次の必須属性を指定する必要があります。

属性	種類	形容	使用例
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"
eventName	糸	Webhookが作成されたときの内部イベント名。この値は "sitecore.backbone.messages.audit.created"に設定する必要があります。	"sitecore.backbone.messages.audit.created"
enabled	ブーリアン	Webhookが作成時に有効か無効かを決定します。有効にすると、ログはすぐにWebhookターゲットURLに転送され始めます。 Webhookの作成後にこれを変更するには、「 Webhookの無効化」および「 Webhookの有効化」を参照してください。	true又は false

応答では、events配列内のオブジェクトで、idキーにwebhook IDが含まれています。Webhook IDは、Webhookの取得や更新などに使用します。

curl -X POST '<baseURL>/api/v1/eventConfigurations' \
-H 'Authorization: Bearer <bearerToken>' \
-H 'Accept: application/json' \
--data-raw '
{
  "space": "Development",
  "sourceSystem": {
    "$type": "AnySource"
  },
  "destinationSystem": {
    "$type": "Webhook",
    "secret": "<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
    }
  ]
}

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