Skip to content
Last updated

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

[
  {
    "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"
      }
    ]
  }
]
DataTypeDescription
vehicleIdguidID of the vehicle.
vehicleNamestringName of the vehicle.
groupIdstringID of the vehicle's group.
groupNamestringName of the vehicle's group.
serialNumberstringSerial number of the Lytx device.
vinstringVehicle Identification Number.
gpsPositionsobjectInformation about the GPS point.
timeInUtcstringDate and time for the GPS point.
latitudenumberLatitude coordinate for the GPS point.
longitudenumberLongitude coordinate for the GPS point.
speedmsnumberThe vehicle's speed in m/s at this GPS point.
headingnumberThe vehicle's direction, in degrees.
hdopnumberHorizontal dilution of precision. Used to characterize the quality of GPS points.
hAccuracyMnumberHorizontal accuracy in meters. Used to characterize the quality of GPS points.
timezonestringThe timezone for the date and time fields.
ingestedDateUtcstringDate 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.

MethodTiming
HTTP POSTEvery 5 Seconds or 500 GPS points (max per call: 500).