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

Copy

Copied

[
  {
    "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
  }
]

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.
code	string	Code of the issue detected.
description	string	Short description of the issue detected.
source	string	The ECM type (e.g. J1939, OBD2).
sourceId	string	The ECU source address.
active	boolean	Indicates 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.

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