Skip to content
Last updated

DTC Webhook Reference

The DTC webhook integration allows clients to bring DTC data from Lytx® devices into a 3rd-party system. Clients can leverage this data to power robust maintenance solutions to help keep their vehicles in top condition.

Sample Payload

[
  {
    "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "vehicleName": "TestVehicle123",
    "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "groupName": "Fleet Manager",
    "serialNumber": "MV20231122",
    "vin": "1M8GDM9AXKP042788",
    "code": "P0068",
    "description": "MAP/MAF - Throttle Position Correlation",
    "source": "OBD2",
    "sourceId": "2024",
    "active": true
  }
]
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.
codestringCode of the issue detected.
descriptionstringShort description of the issue detected.
sourcestringThe ECM type (e.g. J1939, OBD2).
sourceIdstringThe ECU source address.
activebooleanIndicates if the DTC is still active. After the issue is resolved, the DTC is returned as active: false.

Delivery

Multiple messages will be sent every 5 seconds containing a list of vehicle names and their respective DTCs. Each message can have up to 500 DTCs from any combination of vehicles.

MethodTiming
HTTP POSTEvery 5 Seconds or every 500 DTCs (max per call: 500).