{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"DTC Webhook Reference","description":"The best API documentation generator ever.","siteUrl":"https://developer-portal-starter.redoc.ly","keywords":"redocly developer portal, api portal starter, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"dtc-webhook-reference","__idx":0},"children":["DTC Webhook Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sample-payload","__idx":1},"children":["Sample Payload"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"vehicleId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"vehicleName\": \"TestVehicle123\",\n    \"groupId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"groupName\": \"Fleet Manager\",\n    \"serialNumber\": \"MV20231122\",\n    \"vin\": \"1M8GDM9AXKP042788\",\n    \"code\": \"P0068\",\n    \"description\": \"MAP/MAF - Throttle Position Correlation\",\n    \"source\": \"OBD2\",\n    \"sourceId\": \"2024\",\n    \"active\": true\n  }\n]\n"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Data"},"children":["Data"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["vehicleId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["guid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of the vehicle."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["vehicleName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the vehicle."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["groupId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of the vehicle's group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["groupName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the vehicle's group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["serialNumber"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Serial number of the Lytx device."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["vin"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Vehicle Identification Number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Code of the issue detected."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Short description of the issue detected."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["source"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ECM type (e.g. J1939, OBD2)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sourceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ECU source address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["active"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates if the DTC is still active. After the issue is resolved, the DTC is returned as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active: false"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delivery","__idx":2},"children":["Delivery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Timing"},"children":["Timing"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Every 5 Seconds or every 500 DTCs (max per call: 500)."]}]}]}]}]}]},"headings":[{"value":"DTC Webhook Reference","id":"dtc-webhook-reference","depth":1},{"value":"Sample Payload","id":"sample-payload","depth":2},{"value":"Delivery","id":"delivery","depth":2}],"frontmatter":{"seo":{"title":"DTC Webhook Reference"}},"lastModified":"2024-05-20T23:04:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/webhook_dtc","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}