Skip to main content
PUT
/
api
/
v2
/
webhooks
/
{id}
Update webhook (V2)
curl --request PUT \
  --url https://api.telemax.com.au/api/v2/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "alertIds": [
    123
  ],
  "isActive": true,
  "isGlobal": true
}
'
{
  "id": 42,
  "url": "https://webhook.site/qa-telemax-test1",
  "alertIds": [
    4261
  ],
  "isActive": false,
  "isGlobal": false,
  "createdAt": "2026-05-29T10:33:22",
  "warning": null
}

​
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.
Rate limit: 20 requests per 60 seconds per token.

​
Endpoint

PUT /api/v2/webhooks/{id}

​
Path parameters

​
id
integer
required
Webhook ID.

​
Request body

{
  "url": "https://your-server.example.com/new-endpoint",
  "alertIds": [101, 103],
  "isActive": true,
  "isGlobal": false
}
FieldTypeRequiredDescription
urlstringYesDestination URL
alertIdsinteger[]Yes (unless isGlobal)Alert configuration IDs to link
isActivebooleanNoEnable or disable deliveries
isGlobalbooleanNoEnable global delivery

​
Response

200 OK — WebhookDto with updated values.

​
Error responses

StatusMeaning
401Missing or invalid token
404Webhook or alert ID not found
422isGlobal is false and alertIds is empty, or alertIds contains more than 50 entries
curl -X PUT "https://api.telemax.com.au/api/v2/webhooks/7" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://your-server.example.com/new-endpoint","alertIds":[101],"isActive":false,"isGlobal":false}'

Authorizations

​
Authorization
string
header
required

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

​
id
integer
required

Body

application/json
​
url
string<uri>
required
​
alertIds
integer[]
required

IDs of alerts to subscribe to. Must be of a supported type (see POST /api/v2/webhooks). Required when isGlobal is false.

​
isActive
boolean
​
isGlobal
boolean

Response

Successful response