[Beta] EngineFaultOn Event Schema

[Beta] EngineFaultOn Webhook Payload

This webhook is in Beta. Contact support to express interest in consuming EngineFaultOn webhook events. The Samsara Product team is reviewing each request to help us build out a sense of use cases for this endpoint. Approval is required based on use case to ensure we can provide a stable and consistent experience long term. We may reach out with additional questions.

Example

{
    "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
    "eventTime": "1970-01-20T06:39:05.683Z",
    "eventType": "EngineFaultOn",
    "orgId": 20936,
    "webhookId": "1411751028848270",
    "data": {
        "fault": {
            "j1939": {
                "fmi": {
                    "description": "Description",
                    "id": "1"
                },
                "lamps": {
                    "emissions": true,
                    "protect": true,
                    "stop": true,
                    "warning": true
                },
                "occurrenceCount": 1,
                "spn": {
                    "description": "Description",
                    "id": "1"
                },
                "txId": "1",
                "vendorDtcDescription": "Description",
                "volvoRepairInstructions": "https://www.volvo.com"
            },
            "oem": {
                "codeDescription": "KVGT Servo Error",
                "codeIdentifier": "CA2387",
                "codeSeverity": "L03",
                "codeSource": "ENG/M"
            },
            "passenger": {
                "dtc": {
                    "description": "Description",
                    "shortCode": "Short Code",
                    "troubleCode": 1
                },
                "lamps": {
                    "emissions": true
                }
            }
        },
        "vehicle": {
            "assetType": "vehicle",
            "externalIds": {
                "maintenanceId": "250020"
            },
            "gateway": {
                "model": "VG34",
                "serial": "GFRV-43N-VGX"
            },
            "id": "494123",
            "licensePlate": "6SAM123",
            "name": "Fleet Truck #1",
            "vin": "1GBJ6P1B2HV112765"
        }
    }
}

Reference

Property NameDescription
fault
object
Faults are triggered when there are malfunctions in a vehicle or heavy equipment.
 j1939
 object
J1939 Fault
  fmi
  object
FMI
   description
   string
Description of FMI
   id
   string
FMI ID
  lamps
  object
Lamp statuses for J1939
   emissions
   boolean
The emissions lamp is involved in this fault.
   protect
   boolean
The protect lamp is involved in this fault.
   stop
   boolean
The stop lamp is involved in this fault.
   warning
   boolean
The warning lamp is involved in this fault.
  occurrenceCount
  integer
Number of occurrences
  spn
  object
SPN
   description
   string
Description of SPN
   id
   string
SPN ID
  txId
  string
txId
  vendorDtcDescription
  string
Vendor DTC Description
  volvoRepairInstructions
  string
URL for Volvo Repair Instructions
 oem
 object
OEM Fault
  codeDescription
  string
The OEM code description.
  codeIdentifier
  string
The OEM code identifier.
  codeSeverity
  string
The OEM code severity.
  codeSource
  string
The OEM code source.
 passenger
 object
Passenger Fault
  dtc
  object
DTC
   description
   string
Description of DTC
   shortCode
   string
Short Code for DTC
   troubleCode
   integer
Trouble Code
  lamps
  object
Lamp statuses for Passenger
   emissions
   boolean
The emissions lamp is involved in this fault.
vehicle
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
 assetType
 string
The type of the asset. Valid values: uncategorized, trailer, equipment, unpowered, vehicle.
 externalIds
 object
A map of external ids
 gateway
 object
A minified gateway object
  model
  string
The model of the gateway installed on the asset. Valid values: AG15, AG24, AG24EU, AG26, AG26EU, AG41, AG41EU, AG45, AG45EU, AG46, AG46EU, AG46P, AG46PEU, AG51, AG51EU, AG52, AG52EU, AG53, AG53EU, AT11, AT11X, AT12, AT12X, AT13, IG15, IG21, IG41, IG61, SG1, SG1B, SG1G, SG1G32, SG1x, VG32, VG33, VG34, VG34EU, VG34FN, VG34M, VG54ATT, VG54EU, VG54FN, VG54NA, VG54NAE, VG54NAH, VG55EU, VG55FN, VG55NA.
  serial
  string
The serial number of the gateway installed on the asset.
 id
 string
ID of the vehicle
 licensePlate
 string
The license plate of the vehicle.
 name
 string
Name of the vehicle
 vin
 string
The VIN of the vehicle.

Did this page help you?