GPS Webhook Reference

The GPS webhook integration allows clients to bring GPS data from Lytx® devices into a 3rd-party system. Clients can leverage this data for a variety of uses including maintenance, payroll, and routing.

Sample Payload

Copy

Copied

[
  {
    "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vehicleName": "TestVehicle123",
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "groupName": "Fleet Manager",
    "serialNumber": "MV20231122",
    "vin": "1HGCM72603A047217",
    "gpsPositions": [
      {
        "timeInUtc": "2023-03-01T11:48:05.000Z",
        "latitude": 32.888721,
        "longitude": -117.212616,
        "speedms": 4.489,
        "heading": 210.46,
        "hdop": 0.83,
        "hAccuracyM": 4.3,
        "timezone": "UTC",
        "ingestedDateUtc": "2023-04-19T20:55:41.662Z"
      }
    ]
  }
]

Data	Type	Description
vehicleId	guid	ID of the vehicle.
vehicleName	string	Name of the vehicle.
groupId	string	ID of the vehicle's group.
groupName	string	Name of the vehicle's group.
serialNumber	string	Serial number of the Lytx device.
vin	string	Vehicle Identification Number.
gpsPositions	object	Information about the GPS point.
timeInUtc	string	Date and time for the GPS point.
latitude	number	Latitude coordinate for the GPS point.
longitude	number	Longitude coordinate for the GPS point.
speedms	number	The vehicle's speed in m/s at this GPS point.
heading	number	The vehicle's direction, in degrees.
hdop	number	Horizontal dilution of precision. Used to characterize the quality of GPS points.
hAccuracyM	number	Horizontal accuracy in meters. Used to characterize the quality of GPS points.
timezone	string	The timezone for the date and time fields.
ingestedDateUtc	string	Date and time when the GPS point was sent to Lytx.

Delivery

Multiple messages will be sent every 5 seconds containing a list of vehicle names and their respective GPS location points. Each message will be for a specific vehicle. Each message can have up to 500 GPS points.

Method	Timing
HTTP POST	Every 5 Seconds or 500 GPS points (max per call: 500).