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

​
Overview

Returns a webhook by its ID. The caller must own the webhook (it must belong to their company).
Rate limit: 60 requests per 60 seconds per token.

​
Endpoint

GET /api/v2/webhooks/{id}

​
Path parameters

​
id
integer
required
Webhook ID.

​
Response

200 OK — WebhookDto
FieldTypeDescription
idintegerWebhook ID
urlstringDestination URL
alertIdsinteger[]Linked alert configuration IDs
isActivebooleanWhether deliveries are enabled
isGlobalbooleanWhether global delivery is enabled
createdAtdatetimeUTC creation timestamp
warningstring | nullWarning about mixed alert type payloads

​
Error responses

StatusMeaning
401Missing or invalid token
404Webhook not found
curl "https://api.telemax.com.au/api/v2/webhooks/7" \
  -H "Authorization: Bearer <token>"

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

Response

Successful response