Skip to main content
POST
Link alert to webhook (V2)

Overview

Adds an alert configuration to an existing webhook’s subscription list. Idempotent — if the alert is already linked, the response is 200 with no change. The webhook and the alert configuration can belong to the token’s company or a direct, non-cancelled sub-company (see Token scoping). A global webhook cannot have links: the response is 422. Use this when you want to add alerts one at a time after creation, rather than updating the full alertIds list via PUT /v2/api/webhooks/{id}.
Rate limit: 4 req/s · 20/min · 600/hr · 14,400/day

Endpoint

POST /v2/api/webhooks/{id}/link-alert

Path parameters

integer
required
Webhook ID.

Request body

Response

200 OK — empty body on success.

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
alertId
integer
required
Example:

103

Response

200 OK — Empty body. Alert linked successfully.