Skip to main content
POST
Create webhook (V2)

Overview

Creates a webhook for the authenticated company. The plaintext HMAC signing secret is included in the response only on creation — it is never returned again. Store it securely.
Rate limit: 4 req/s · 20/min · 600/hr · 14,400/day

Endpoint

POST /v2/api/webhooks

Request body

Response

200 OKCreateWebhookResponse (extends WebhookDto)

Example response

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 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.

Body

application/json
url
string<uri>
required
Example:

"https://your-server.example.com/telemax-webhook"

alertIds
integer[]
required

IDs of alerts to subscribe to. Must be of a supported type (see endpoint description). Required when isGlobal is false.

Example:
isActive
boolean
default:true
isGlobal
boolean
default:false

Response

Successful response