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

Overview

Returns active webhooks belonging to the caller’s company.
Rate limit: 60 requests per 60 seconds per token.

Endpoint

GET /api/v2/webhooks

Query parameters

page
integer
default:"1"
Page number (1-based).
pageSize
integer
default:"50"
Records per page.

Response

200 OKPagedListResult<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
The HMAC secret is not returned in list responses. It is only included in the POST /api/v2/webhooks response at creation time.

Error responses

StatusMeaning
401Missing or invalid token
curl "https://api.telemax.com.au/api/v2/webhooks?page=1&pageSize=50" \
  -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.

Query Parameters

page
integer
default:1
pageSize
integer
default:50

Response

Successful response