Skip to main content

Vehicle event

caution

The vehicle data inside items[] is included in the response only when received. It is an optional value.

Request Info​

  • Protocol: HTTPS (Mandatory)
  • Method: POST

Request Header​

The request header includes the following values.

KeyDescriptionType(Sample) Value
Content-TypeContent TypeStringapplication/json; charset=utf-8
X-API-VersionVersion of Fleet APIStringv1.0
X-Custom-Key(Optional) Custom header registered by the user when registering the WebhookStringMy custom value

Payload Schema​

KeyDescriptionTypeSample value
vinVehicle Identification NumberStringHMGSDV00000000001
vehicleIdVehicle unique IDStringe79049fb-e744-11ef-8dd9-f56aaa011ede
itemsCountNumber of itemsInteger3
itemsArray of vehicle dataObject Array
items[].messageTimeTime when vehicle data was recorded (ISO 8601)String2025-02-12T08:12:58.628000000Z
items[].dataVehicle data objectObject
items[].data.Vehicle.Ignition1Ignition - IG1ValueObject<String>[ "OFF", "ON" ]
items[].data.Vehicle.Ignition2Ignition - IG2ValueObject<String>[ "OFF", "ON" ]
items[].data.Vehicle.Ignition3Ignition - IG3ValueObject<String>[ "OFF", "ON" ]
items[].data.Vehicle.IgnitionAccIgnition - ACCValueObject<String>[ "OFF", "ON" ]
items[].data.Vehicle.DrivingReadyIgnition - ONValueObject<String>[ "OFF", "ON" ]
items[].data.Door.Open.DriverDoor Open/Close Status - DriverValueObject<String>[ "CLOSE", "OPEN" ]
items[].data.Door.Lock.DriverDoor Lock Status - DriverValueObject<String>[ "LOCK", "UNLOCK" ]
items[].data.Hood.OpenHood Open/Close StatusValueObject<String>[ "CLOSE", "OPEN" ]
items[].data.Trunk.OpenTrunk open statusValueObject<String>[ "CLOSE", "OPEN" ]
items[].data.ChargePort.PlugCharger connection statusValueObject<String>[ "PLUG", "UNPLUG" ]
items[].data.Emergency.CrashCrash statusValueObject<String>[ "CRASH", "UNCRASH" ]
items[].data.Seat.Buckle.DriverDriver seatbelt statusValueObject<String>[ "BUCKLE", "UNBUCKLE" ]
items[].data.Seat.Buckle.PassengerPassenger seatbelt statusValueObject<String>[ "BUCKLE", "UNBUCKLE" ]
items[].data.ParkingBrake.EngageParking brakeValueObject<String>[ "DISENGAGE", "ENGAGE" ]
items[].data.WarningLamp.AirbagAirbag Warning LightValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.EBDEBD Warning LightValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.ABSABS Warning LightValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.EPSEPS Warning LightValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.ChargingSystemCharging system warning lampValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.TirePressure.FrontLeftTire pressure - Front leftValueObject<String>[ "LOW", "NORMAL" ]
items[].data.WarningLamp.TirePressure.FrontRightTire pressure - Front rightValueObject<String>[ "LOW", "NORMAL" ]
items[].data.WarningLamp.TirePressure.RearLeftTire pressure - Rear leftValueObject<String>[ "LOW", "NORMAL" ]
items[].data.WarningLamp.TirePressure.RearRightTire pressure - Rear rightValueObject<String>[ "LOW", "NORMAL" ]
items[].data.WarningLamp.HeadLampLED headlamp warning lampValueObject<String>[ "DEFECT", "NORMAL" ]
items[].data.WarningLamp.EPBEPB warning lampValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.ESCESC warning lampValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.RegenerativeBrakeRegenerative braking warning lampValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.TractionBatterySOCTraction battery low voltage warning lampValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.EVPowerDownPower down warning lampValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.EVServiceEV service warning lampValueObject<String>[ "BLINK", "OFF", "ON" ]
items[].data.WarningLamp.WasherFluidWasher fluid low warning lampValueObject<String>[ "LOW", "NORMAL" ]
items[].data.WarningLamp.BrakeOilBrake fluid warning lampValueObject<String>[ "LOW", "NORMAL" ]
items[].data.WarningLamp.AuxiliaryBatterySOC12V battery lowValueObject<String>[ "LOW", "NORMAL" ]

Payload examples​

Payload example 1​

{
  "vin": "HMGSDV00000000001",
  "vehicleId": "e79049fb-e744-11ef-8dd9-f56aaa011ede",
  "itemsCount": 3,
  "items": [
    {
      "messageTime": "2025-02-12T08:12:58.628000000Z",
      "data": {
        "Vehicle": {
          "Seat": {
            "Buckle": {
              "Driver": {
                "value": false,
                "eventTime": "2025-01-31T01:17:40.702000000Z"
              }
            }
          }
        }
      }
    }
  ]
}