Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Webhook

webhook.update

Updates a webhook setting. One of enabled, requestUrl, or secretToken must be provided.

Requires the apiKeysWrite permission.

post/webhook.update

Request body

webhookIdstring uuid required

The id of the webhook setting to update

enabledboolean

Whether or not the webhook setting is enabled

requestUrlstring uri

The URL the webhook will send requests to

secretTokenstring nullable

The secret token used to sign the webhook request. Pass null to clear. See our documentation here for more information.

Example request

{
  "webhookId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the webhook.update endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "enabled": true,
    "requestUrl": "https://example.com/webhook1",
    "webhookType": "applicationSubmit",
    "secretToken": "your-secret-token-here"
  }
}