Webhook Events
sync.completed
- Documentation
- API Reference
- Website
- Product Roadmap
- Terminal Telematics API
- POSTPublic Token Exchange
- GETList Vehicles
- GETGet Vehicle
- GETLatest Vehicle Locations
- GETHistorical Vehicle Locations
- GETHistorical Vehicle Stats
- GETList Trips
- GETList Devices
- GETList Safety Events
- GETList Groups
- GETList Providers
- Event Types
- connection.created
- connection.disconnected
- connection.reconnected
- connection.completed
- connection.updated
- sync.requested
- sync.started
- sync.completed
- sync.failed
- connection.first_sync_completed
- issue.reported
- issue.resolved
- unsupported_provider.requested
- vehicle.added
- vehicle.modified
- vehicle.removed
- driver.added
- driver.modified
- driver.removed
- vehicle.location_updated
- safety_event.added
- safety_event.modified
API Reference
Authentication
Vehicles
Trips
Devices
Safety
Groups
Providers
Webhook Events
Webhook Events
sync.completed
Emitted when a connection sync completes successfully.
id
string
requiredtype
enum<string>
requiredAvailable options:
sync.completed
timestamp
string
requiredISO 8601 date
detail
object
requireddetail.connection
object
requiredBasic connection details to be able to reference connections from webhook events
detail.connection.id
string
requireddetail.connection.provider
object
requireddetail.connection.provider.code
enum<string>
requiredAvailable options:
azuga
, bigroad
, conti-go
, eld-mandate
, eld-mandate-plus
, eld-rider
, eldone
, envue-telematics
, eroad
, fleet-complete-hub
, fleetistics
, fort-knox
, fm-eld
, geotab
, gofleet
, gogps
, gps-insight
, gpstab
, isaac
, ksk
, linxup
, coretex-360
, apollo
, apollo-eld
, apollo-compass
, eld-mandate-prime
, hos-reporter-plus
, master-eld
, monarch-tracking
, motive
, mountain-eld
, omnitracs-es
, omnitracs-xrs
, omnitracs
, optima-eld
, pro-ride-eld
, pti-eld
, real-eld
, right-trucking
, roadstar
, samsara
, sandbox
, sparkle-eld
, tx-eld
, surfsight
, tfm-eld
, transflo
, truckx
, tt-eld
, verizon-fleet
, verizon-reveal
, verizon
, webfleet
, xeld
, xplore-eld
, zonar
, geotab-att
, zippy-eld
, evo-eld
, ontime-eld
detail.connection.provider.name
string
requireddetail.connection.externalId
string
detail.connection.tags
string[]
detail.sync
object
requiredAn object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion.
detail.sync.id
string
requireddetail.sync.status
enum<string>
requiredAvailable options:
requested
, in_progress
, completed
, failed
detail.sync.failureReason
string
If the sync failed, this will contain the reason
detail.sync.issues
array
Issues are problems encountered with a connection that did not result in a failed sync but may require manual intervention. You can see the issues for a given sync by providing issues
to the expand
parameter.
detail.sync.startFrom
string
The earliest records to sync for those based on time (ex: historical locations and stats)
detail.sync.requestedAt
string
requiredISO 8601 date
detail.sync.completedAt
string
ISO 8601 date