Event catalogue
The events a webhook subscription can receive, as webhooks-service publishes them
(also GET /v1/webhooks/events). Subscribe with the exact name, the name without its version
(zaitrack.alert.raised matches every version), a prefix wildcard (zaitrack.alert.*) or *.
| Event | Schema version | When |
|---|---|---|
zaitrack.device.registered.v1 | 1.0.0 | A tracker or sensor was registered to the fleet. |
zaitrack.device.bound.v1 | 1.0.0 | A device was fitted to a vehicle, a trailer or a driver. |
zaitrack.device.unbound.v1 | 1.0.0 | A device was taken off what it was fitted to (removed, retired or sent for repair). |
zaitrack.device.retired.v1 | 1.0.0 | A device was retired from service. |
zaitrack.vehicle.created.v1 | 1.0.0 | A vehicle was added to the fleet. |
zaitrack.vehicle.assigned.v1 | 1.0.0 | A vehicle was given a primary driver. |
zaitrack.driver.created.v1 | 1.0.0 | A driver was hired (the name is sent only as a hash). |
zaitrack.driver.key.rejected.v1 | 1.0.0 | A driver ID key or card was presented that the vehicle does not accept. |
zaitrack.trip.started.v1 | 1.1.0 | A vehicle's trip is underway (past 0.2 km or a minute), with where and how it began. |
zaitrack.trip.completed.v1 | 1.0.0 | A vehicle's trip ended: distance, duration, idling, top speed and harsh-driving counts. |
zaitrack.geofence.entered.v1 | 1.0.0 | A vehicle entered a geofence. |
zaitrack.geofence.exited.v1 | 1.0.0 | A vehicle left a geofence. |
zaitrack.alert.raised.v1 | 1.0.0 | An alert was opened (rule match, geofence, maintenance, fuel, HOS, dispatch). |
zaitrack.alert.acknowledged.v1 | 1.0.0 | Someone acknowledged an alert. |
zaitrack.alert.resolved.v1 | 1.0.0 | An alert was resolved (manually or because the condition cleared). |
zaitrack.dispatch.stop.completed.v1 | 1.0.0 | A job stop was completed, with proof of delivery. |
zaitrack.dispatch.stop.late.v1 | 1.0.0 | A job stop is expected to be late. |
zaitrack.hos.violation.v1 | 1.0.0 | A driver broke an hours-of-service rule. |
zaitrack.fuel.transaction.flagged.v1 | 1.0.0 | A fuel purchase failed the telemetry checks. |
zaitrack.fuel.tank.drain.v1 | 1.0.0 | Fuel left a standing vehicle's tank: more than a standing engine burns. |
zaitrack.securetrip.event.v1 | 1.0.0 | Something happened on a secured trip: a seal, door or lock event, or a stop off the route. |
zaitrack.vehicle.crash.detected.v1 | 1.0.0 | A vehicle's tracker reported an impact, with the position, speed, driver and trip at that moment. |
zaitrack.adapters.connector.payment.v1 | 1.0.0 | Payments and refunds read from a payment gateway (Tap, PayTabs, Stripe). |
zaitrack.toll.charge.flagged.v1 | 1.0.0 | A toll charge does not match where the vehicle was. |
zaitrack.tachograph.infringement.detected.v1 | 1.0.0 | A tachograph download shows a driving-time infringement. |
zaitrack.screening.hit.detected.v1 | 1.0.0 | A party screened against sanctions lists matched an entry. |
zaitrack.maintenance.service-due.v1 | 1.0.0 | A vehicle is due (or overdue) for service. |
zaitrack.maintenance.work-order.created.v1 | 1.0.0 | A maintenance work order was opened. |
zaitrack.maintenance.work-order.completed.v1 | 1.0.0 | A maintenance work order was completed. |
zaitrack.maintenance.inspection.defect.v1 | 1.0.0 | A vehicle inspection found a defect. |
zaitrack.maintenance.inspection.cleared.v1 | 1.0.0 | An inspection's defects were cleared. |
zaitrack.maintenance.document-expiry.v1 | 1.0.0 | A vehicle's or driver's document is about to expire, or has. |
zaitrack.tire.condition.v1 | 1.0.0 | A tire's pressure or temperature reached a warning or critical level. |
zaitrack.trailer.condition.v1 | 1.0.0 | A trailer's reefer, door or coupling reported a condition worth acting on. |
zaitrack.webhook.test.v1 | — | Sent by POST /v1/webhooks/{id}:test when no event is named; not subscribable. |
The envelope and the headers of a delivery are in Webhooks.