Link alert to webhook (V2)
Webhooks
Link alert
Links an alert configuration to an existing webhook.
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 is200 with no change.
Use this when you want to add alerts one at a time after creation, rather than updating the full alertIds list via PUT /api/v2/webhooks/{id}.
Rate limit: 20 requests per 60 seconds per token.
Endpoint
POST /api/v2/webhooks/{id}/link-alert
Path parameters
Webhook ID.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| alertId | integer | Yes | Alert configuration ID to link (from GET /api/v2/companies/{id}/alerts) |
Response
200 OK — empty body on success.Error responses
| Status | Meaning |
|---|---|
| 401 | Missing or invalid token |
| 403 | Webhook or alert does not belong to the caller’s company |
| 404 | Webhook or alert configuration not found |
| 422 | Unsupported alert type, or webhook already has 50 linked alerts (maximum) |
Authorizations
JWT Bearer token obtained from POST /api/v2/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 to the company the key belongs to and may restrict access to a vehicle allowlist and/or action set (see token claims).
No refresh endpoint — re-authenticate with your API key when the token expires.
Path Parameters
Body
application/json
Example:
103
Response
200 OK — Empty body. Alert linked successfully.