ウェブフックの更新

PATCH /api/v1/eventConfigurations/

ウェブフックを更新します。

ウェブフックの秘密情報、ターゲットURL、ログレベルを更新でき、ウェブフックの有効化・無効化も可能です。

属性

種類

概要

例

webhookID

ストリング

ウェブフックのID。

ウェブフックのIDがわからない場合は、まず ウェブフックを取得してください。

7050346545d5447da57b64be6416ac78

更新できる属性は以下の通りです: destinationSystem.secret、destinationSystem.targetUrl、logLevel、enabled。

属性

種類

概要

例

destinationSystem.secret

ストリング

あなたが定義した秘密は、 X-Secret リクエストヘッダーで自動的に渡されます。受信するウェブフックコールを認証するには、ターゲットアプリケーションがこの秘密を検証しなければなりません。

"mys3cr3tstr1ingforauth1!x"

destinationSystem.targetUrl

ストリング

ウェブフックのターゲットURL。これがログが転送されるURLです。

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

logLevel

ストリング

ウェブフックメッセージが外部システムに送信されなかった場合、またはメッセージが正常送信された場合にのみ記録してください。

"FailuresOnly" - ウェブフックメッセージが送信されなかった場合にのみ記録。

"All" - ウェブフックメッセージが失敗した時と送信成功時の両方を記録します。

デフォルト: "FailuresOnly"

以下のいずれかでなければなりません:

• "All"
• "FailuresOnly"

enabled

ブール値

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

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

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

true または false

以下はウェブフックのターゲット秘密とURLを更新する例です:

curl -X PATCH '/api/v1/eventConfigurations/7050346545d5447da57b64be6416ac78' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ --data-raw ' { "destinationSystem": { "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": "2026-12-22T12:`10