Skip to main content
This page is a reference overview of the Notifications API — the webhook subscription system that backs real-time, event-driven integrations with the Catena platform. It covers creating and managing subscriptions, inspecting delivery logs, replaying failed events, and reading versioned event schemas. It is not a release entry: these endpoints were introduced across many releases, and the Notifications API has been documented since November 2025. For dated changes, see the changelog index.
Base URL: The Notifications API is served at https://api.catenatelematics.com/v2/notifications/. All endpoints require Bearer token authentication.

​
Webhook Subscriptions

A full CRUD interface for managing webhook subscriptions.Added:
  • GET /v2/notifications/webhooks — List all webhook subscriptions with filtering and cursor-based pagination
  • POST /v2/notifications/webhooks — Create a new webhook subscription
  • GET /v2/notifications/webhooks/{webhook_id} — Retrieve a single webhook subscription by ID
  • PATCH /v2/notifications/webhooks/{webhook_id} — Update an existing webhook subscription
  • DELETE /v2/notifications/webhooks/{webhook_id} — Delete a webhook subscription
Control the active state of webhook subscriptions without deleting them.Added:
  • POST /v2/notifications/webhooks/{webhook_id}/pause — Pause a webhook subscription to temporarily stop event delivery
  • POST /v2/notifications/webhooks/{webhook_id}/activate — Reactivate a paused or stale webhook subscription

​
Delivery Monitoring & Replay

Inspect delivery history and track webhook health over time.Added:
  • GET /v2/notifications/webhooks/{webhook_id}/logs — Retrieve paginated delivery attempt logs for a webhook
  • GET /v2/notifications/webhooks/{webhook_id}/metrics — Retrieve aggregated delivery metrics (success rates, failure counts, time-period breakdowns)
Recover events from the Dead Letter Queue after outages or delivery failures.Added:
  • POST /v2/notifications/webhooks/{webhook_id}/replay — Replay failed events stored in the Dead Letter Queue

​
Event Schemas

Access versioned OpenAPI 3.0 schemas for all webhook event types.Added:
  • GET /v2/notifications/schemas/{event_name} — Retrieve the schema definition for a specific event type
  • GET /v2/notifications/schemas/{event_name}/versions/{version} — Retrieve a specific historical version of an event schema

​
Supported Event Types

The API supports the following webhook event categories:

​
Schemas

The API defines over 200 schemas covering the full webhook event catalog, including:
  • Webhook management: WebhookRead, WebhookCreate, WebhookUpdate, WebhookMetrics, WebhookLogRead
  • Event envelopes: BaseWebhookEvent, BaseExecutionEvent, BaseConnectionEvent
  • Telematics events: VehicleAdded, VehicleModified, VehicleLocationAdded, EngineStatusAdded, EngineLogAdded
  • HOS events: HosEventAdded, HosViolationAdded, HosDailySnapshotAdded, HosAvailabilityAdded
  • Organizational events: InvitationSent, ShareAgreementCreated, FleetConnectionCreated, TspCreated
  • Error responses: BadRequest, Unauthorized, Forbidden, NotFound, Conflict, TooManyRequests, InternalServerError