1. WebhookのREST API

Webhookを更新する

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

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

PATCH /api/v1/eventConfigurations/{:placeholder-token:}<webhookID>{/:placeholder-token:}

Webhookを更新します。

Webhookのシークレット、ターゲットURL、およびログ レベルを更新したり、Webhookを有効または無効にしたりできます。

更新できる属性は、destinationSystem.secret、destinationSystem.targetUrl、logLevel、およびenabledのみです。

属性

種類

形容

使用例

destinationSystem.secret

糸

Webhookターゲットのシークレット。この値は、Webhookターゲットが呼び出されたときに、X-Secret要求ヘッダーに自動的に渡されます。

該当なし

destinationSystem.targetUrl

糸

WebhookターゲットURL。これは、ログの転送先のURLです。

"https://www.exampletarget.url/example-endpoint"

logLevel

糸

Webhookメッセージを外部システムに送信しなかった場合、またはメッセージが正常に送信された場合にのみ記録します。

"FailuresOnly" - Webhookメッセージの送信に失敗した場合のみ記録します。

"All" - Webhookメッセージが失敗したときと、正常に送信されたときの両方を記録します。

デフォルト： "FailuresOnly"

次のいずれかである必要があります。

  • "All"

  • "FailuresOnly"

enabled

ブーリアン

Webhookが作成時に有効か無効かを決定します。

有効にすると、ログはすぐにWebhookターゲットURLに転送され始めます。

Webhookの作成後にこれを変更するには、「 Webhookの無効化 」および「 Webhookの有効化」を参照してください。

true又は false

WebhookターゲットのシークレットとURLを更新する例を次に示します。

curl -X PATCH '<baseURL>/api/v1/eventConfigurations/7050346545d5447da57b64be6416ac78' \
-H 'Authorization: Bearer <bearerToken>' \
-H 'Content-Type: application/json' \
--data-raw '
{
  "destinationSystem": {
    "secret": "<new-secret>",
    "targetUrl": "https://www.exampletartget.url/new-example-endpoint"
  }
}'
{
  "id": "7050346545d5447da57b64be6416ac78",
  "organizationId": "org_ZiiCnzhCeHDpWJAU",
  "sourceSystem": {
    "$type": "AnySource"
  },
  "destinationSystem": {
    "secret": "new-4fcae82f-5759-4a08-93fe-1582bcc8514d",
    "targetUrl": "https://webhook.site/new-example-endpoint",
    "contentType": null,
    "$type": "Webhook"
  },
  "space": "Development",
  "sourceSystemStatus": null,
  "logLevel": "FailuresOnly",
  "createdBy": "[email protected]",
  "createdDate": "2025-12-22T12:10:18.8610786+00:00",
  "updatedBy": "[email protected]",
  "updatedDate": "2025-12-28T11:04:32.4291852+00:00",
  "eventName": "sitecore.backbone.messages.audit.created",
  "enabled": true
}
この記事を改善するための提案がある場合は、 お知らせください!