Update a webhook
PATCH /api/v1/eventConfigurations/<webhookID>
Updates a webhook.
You can update the secret, target URL, and log level of your webhook, and you can enable or disable the webhook.
| Attribute | Type | Description | Example |
|---|---|---|---|
webhookID | string | The webhook ID. If you do not know the webhook ID, first retrieve webhooks. | 7050346545d5447da57b64be6416ac78 |
You can only update the following attributes: destinationSystem.secret, destinationSystem.targetUrl, logLevel, and enabled.
| Attribute | Type | Description | Example(s) |
|---|---|---|---|
destinationSystem.secret | string | A secret you define, automatically passed in the X-Secret request header. To authenticate incoming webhook calls, your target application must verify this secret. | "mys3cr3tstr1ingforauth1!x" |
destinationSystem.targetUrl | string | The webhook target URL. This is the URL that logs will be forwarded to. | "https://www.exampletarget.url/example-endpoint" |
logLevel | string | Record only when a webhook message fails to be sent to an external system, or also when the message is successfully sent."FailuresOnly" - record only when a webhook message fails to be sent."All" - record both when a webhook message fails and when it is successfully sent.Default: "FailuresOnly" | Must be one of:
|
enabled | boolean | Determines whether the webhook is enabled or disabled at creation time. When enabled, logs will immediately start being forwarded to the webhook target URL. To change this after creating the webhook, see Disable a webhook and Enable a webhook. | true or false |
Here's an example of updating a webhook target secret and URL:
If you have suggestions for improving this article, let us know!