{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"GPS 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":"gps-webhook-reference","__idx":0},"children":["GPS Webhook Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$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\": \"1HGCM72603A047217\",\n    \"gpsPositions\": [\n      {\n        \"timeInUtc\": \"2023-03-01T11:48:05.000Z\",\n        \"latitude\": 32.888721,\n        \"longitude\": -117.212616,\n        \"speedms\": 4.489,\n        \"heading\": 210.46,\n        \"hdop\": 0.83,\n        \"hAccuracyM\": 4.3,\n        \"timezone\": \"UTC\",\n        \"ingestedDateUtc\": \"2023-04-19T20:55:41.662Z\"\n      }\n    ]\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":["gpsPositions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Information about the GPS point."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["timeInUtc"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time for the GPS point."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["latitude"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Latitude coordinate for the GPS point."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["longitude"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Longitude coordinate for the GPS point."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["speedms"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The vehicle's speed in m/s at this GPS point."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["heading"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The vehicle's direction, in degrees."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hdop"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Horizontal dilution of precision. Used to characterize the quality of GPS points."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hAccuracyM"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Horizontal accuracy in meters. Used to characterize the quality of GPS points."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["timezone"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The timezone for the date and time fields."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ingestedDateUtc"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date and time when the GPS point was sent to Lytx."]}]}]}]}]},{"$$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 GPS location points. Each message will be for a specific vehicle. Each message can have up to 500 GPS points."]},{"$$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 500 GPS points (max per call: 500)."]}]}]}]}]}]},"headings":[{"value":"GPS Webhook Reference","id":"gps-webhook-reference","depth":1},{"value":"Sample Payload","id":"sample-payload","depth":2},{"value":"Delivery","id":"delivery","depth":2}],"frontmatter":{"seo":{"title":"GPS Webhook Reference"}},"lastModified":"2024-05-20T23:04:03.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/webhook_gps","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}