Skip to main content
PUT
Update webhook (V2)

Overview

Updates a webhook. The request body replaces the entire webhook configuration — include all fields you want to keep, not just the ones you are changing. Omitted fields take their defaults: isActive becomes true, so omitting it re-enables a disabled webhook, and isGlobal becomes false. The webhook can belong to the token’s company or a direct, non-cancelled sub-company (see Token scoping).
Rate limit: 4 req/s · 20/min · 600/hr · 14,400/day

Endpoint

PUT /v2/api/webhooks/{id}

Path parameters

integer
required
Webhook ID.

Request body

Response

200 OK — WebhookDto with the new values. warning is set when the linked alerts have different types, or to “Warning: Existing alert links were removed because the webhook is now global.” when a webhook that had links switches to global; otherwise it is null.

Error responses

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from POST /v2/api/authentication/token/api-key.

Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.

Scoping: API key tokens are scoped by the key's company and its action set; see Token scoping.

No refresh endpoint — re-authenticate with your API key when the token expires.

Path Parameters

id
integer
required

Body

application/json
url
string<uri>
required

http or https. The host must contain a dot or be an IP address, must resolve, and must not resolve to a loopback, private, CGNAT, link-local or multicast address, to 0.0.0.0/8 or 240.0.0.0/4, to ::, or to an IPv6 unique-local, 6to4 or Teredo address; otherwise the response is 422. A value that cannot be parsed as a URL is not always refused: it can be accepted, and nothing is ever delivered to it.

alertIds
integer[]

Alert configuration IDs to link, at most 50 distinct; they replace the current links. Required when isGlobal is false; ignored when it is true. Each must be of a type that can be linked (see the endpoint description).

isActive
boolean
default:true
isGlobal
boolean
default:false

Response

Successful response. warning is set when the linked alerts have different types, or when a webhook that had links switches to global and its links are removed.