Sign in

v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB
webhooks

Update webhook

Updates the webhook with the given ID. You can update the name, description, status, URL, and set basic authentication. Changing the URL will require this webhook to be verified again. Changing the status will disable/enable sending of identification events to your webhook.

patch/webhooks/{id}

Path parameters

idstring required

Webhook ID

Headers

X-API-Versionstring required

Management API version.

Request body

urlstring

URL of the webhook endpoint. Must start with https://.

descriptionstring

Description of the webhook.

status'enabled' | 'disabled'

Status of the webhook: 'enabled' or 'disabled'.

environmentobject

Environment ID this webhook is associated with. Null if global.

Example request

{
  "url": "https://website.com/webhook",
  "description": "My Webhook"
}

Response

Webhook updated. Changes will take effect in a few minutes.

environmentobject nullable required

Environment ID this webhook is associated with. Null if global.

Example response

{
  "data": {
    "id": "wh_HYv9YfsIIUjpvR",
    "description": "My Webhook",
    "url": "https://website.com/webhook"
  }
}