Document Webhook Events
This release expands the webhook notification system with support for document lifecycle events, enabling integrations to react to document additions, modifications, and any document-related activity.Backward-compatible addition: All new event types are additive. Existing webhook subscriptions and integrations are unaffected.
New webhook event types
Document events
Document events
Three new values have been added to the You can also filter existing webhooks by the new event types:
WebhookEventNameEnum, available across all webhook endpoints:You can now subscribe to document events when creating or updating a webhook:
Affected endpoints
The new event types are available on all webhook management endpoints:GET /v2/notifications/webhooks— filter by new event namesPOST /v2/notifications/webhooks— subscribe to new event namesGET /v2/notifications/webhooks/{webhook_id}— response includes new enum valuesPATCH /v2/notifications/webhooks/{webhook_id}— update subscription to new event namesPOST /v2/notifications/webhooks/{webhook_id}/activate— response includes new enum valuesPOST /v2/notifications/webhooks/{webhook_id}/pause— response includes new enum valuesGET /v2/notifications/webhooks/{webhook_id}/logs— log entries include new event names
Driver Safety Event URLs
This release adds a newurls field to driver safety event schemas, giving you direct access to associated media and resource links within safety event payloads.
Backward-Compatible Addition: All existing integrations continue to work without changes. The new
urls field is additive and optional.Schema Changes
Driver safety event schemas
Driver safety event schemas
A new
urls property has been added to the following schemas:BaseDriverSafetyEventDriverSafetyEventAddedDriverSafetyEventModified
urls field provides a list of URLs associated with the safety event — for example, links to video clips, images, or other media captured during the event.Example response (new field highlighted):Affected webhook events
Driver Safety Event Webhooks
This release adds webhook support for driver safety events, enabling real-time notifications when safety events are created, updated, or removed in the Catena platform.New Feature: Three new webhook event types cover the full lifecycle of driver safety events — added, modified, and removed — along with a catch-all wildcard subscription.
New webhook events
driver_safety_event.added
driver_safety_event.added
Emitted when a new driver safety event is added to the database — for example, when a record fetched from the TSP is new and generates a new entry in Catena.Event name:
driver_safety_event.addedPayload schema: DriverSafetyEventAddeddriver_safety_event.modified
driver_safety_event.modified
Emitted when a driver safety event is modified in the database — for example, when a record fetched from the TSP differs from what was previously stored and prompts an update.Event name:
driver_safety_event.modifiedPayload schema: DriverSafetyEventModifieddriver_safety_event.removed
driver_safety_event.removed
Emitted when a driver safety event is removed from the database — for example, when a record is deleted from the TSP and removed from Catena.Event name:
driver_safety_event.removedPayload schema: DriverSafetyEventRemoveddriver_safety_event.* (catch-all)
driver_safety_event.* (catch-all)
Subscribe to all driver safety event lifecycle events with a single wildcard subscription.Event name:
driver_safety_event.*Updated endpoints
Theevent_name field across all webhook endpoints now accepts the new driver_safety_event.* values. No changes are required to existing webhook subscriptions — this is a purely additive update.
Need help?
Webhook documentation
Learn how to set up and manage webhooks with the Catena Notifications API
Contact support
Questions about integrating document events? Our team is here to help