[Beta] VehicleUpdated Event Schema
[Beta] VehicleUpdated Webhook Payload
Example
{
"eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
"eventTime": "1970-01-20T06:39:05.683Z",
"eventType": "VehicleUpdated",
"orgId": 20936,
"webhookId": "1411751028848270",
"data": {
"vehicle": {
"attributes": [
{
"id": "494123",
"name": "Compliance/ELD",
"numberValues": [
867,
5309
],
"stringValues": [
"HQ",
"Leased"
]
},
{
"id": "494123",
"name": "Compliance/ELD",
"numberValues": [
867,
5309
],
"stringValues": [
"HQ",
"Leased"
]
}
],
"auxInputType1": "boom",
"auxInputType10": "boom",
"auxInputType11": "boom",
"auxInputType12": "boom",
"auxInputType13": "boom",
"auxInputType2": "boom",
"auxInputType3": "boom",
"auxInputType4": "boom",
"auxInputType5": "boom",
"auxInputType6": "boom",
"auxInputType7": "boom",
"auxInputType8": "boom",
"auxInputType9": "boom",
"cameraSerial": "CNCK-VT8-XA8",
"createdAtTime": "1993-08-25T18:17:06Z",
"esn": "56349811",
"externalIds": {
"maintenanceId": "250020"
},
"gateway": {
"model": "VG34",
"serial": "GFRV-43N-VGX"
},
"harshAccelerationSettingType": "off",
"id": "494123",
"licensePlate": "6SAM123",
"make": "Ford",
"model": "F150",
"name": "Fleet Truck #1",
"notes": "These are notes about this given vehicle.",
"sensorConfiguration": {
"areas": [
{
"cargoSensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
],
"humiditySensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
],
"position": "back",
"temperatureSensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
]
},
{
"cargoSensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
],
"humiditySensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
],
"position": "back",
"temperatureSensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
]
},
{
"cargoSensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
],
"humiditySensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
],
"position": "back",
"temperatureSensors": [
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
},
{
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
]
}
],
"doors": [
{
"position": "back",
"sensor": {
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
},
{
"position": "back",
"sensor": {
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
},
{
"position": "back",
"sensor": {
"id": "12345",
"mac": "00:00:5e:00:53:af",
"name": "Rear temperature sensor"
}
}
]
},
"serial": "VG12345",
"staticAssignedDriver": {
"id": "0987",
"name": "Driver Name"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
},
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
},
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
],
"updatedAtTime": "1979-12-02T11:23:36Z",
"vehicleRegulationMode": "regulated",
"vehicleType": "unset",
"vehicleWeight": 1000,
"vehicleWeightInKilograms": 1000,
"vehicleWeightInPounds": 2200,
"vin": "1GBJ6P1B2HV112765",
"year": "2008"
}
}
}
Reference
Property Name | Description |
---|---|
vehicle object | A single vehicle |
    attributes     object array | List of attributes associated with the entity |
        id         string | Id of the attribute |
        name         string | Name of the attribute |
        numberValues         number array | List of number values associated with the attribute |
        stringValues         string array | List of string values associated with the attribute. |
    auxInputType1     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType10     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType11     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType12     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType13     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType2     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType3     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType4     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType5     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType6     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType7     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType8     string | The type of auxiliary input configured for this Vehicle. |
    auxInputType9     string | The type of auxiliary input configured for this Vehicle. |
    cameraSerial     string | The serial number of the camera installed in the vehicle |
    createdAtTime     string | Time the vehicle was created in RFC 3339 format. |
    esn     string | Engine serial number. |
    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 , 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. |
    harshAccelerationSettingType     string | The harsh acceleration setting type. |
    id     string | ID of the vehicle |
    licensePlate     string | The license plate of the vehicle. |
    make     string | The Vehicle’s manufacturing make. |
    model     string | The Vehicle’s manufacturing model. |
    name     string | Name of the vehicle |
    notes     string | These are generic notes about the Vehicle. |
    sensorConfiguration     object | The sensors configured on a vehicle |
        areas         object array | Configured sensor areas on the vehicle with its associated sensors |
            cargoSensors             object array | |
                id                 string | ID of the sensor |
                mac                 string | The MAC address of the sensor |
                name                 string | The name of the sensor |
            humiditySensors             object array | |
                id                 string | ID of the sensor |
                mac                 string | The MAC address of the sensor |
                name                 string | The name of the sensor |
            position             string | Position of the area on vehicle Valid values: back , front , middle . |
            temperatureSensors             object array | |
                id                 string | ID of the sensor |
                mac                 string | The MAC address of the sensor |
                name                 string | The name of the sensor |
        doors         object array | Configured door monitors on the vehicle |
            position             string | Position of the door monitor on the vehicle Valid values: back , left , right . |
            sensor             object | A sensor |
                id                 string | ID of the sensor |
                mac                 string | The MAC address of the sensor |
                name                 string | The name of the sensor |
    serial     string | The serial number of the gateway installed in the vehicle. |
    staticAssignedDriver     object | Current driver of the vehicle. Note: this parameter includes all assignment sources, not just static assignments. |
        id         string | ID of the driver. |
        name         string | Name of the driver. |
    tags     object array | The list of tags associated with the Vehicle. |
        id         string | ID of the tag |
        name         string | Name of the tag. |
        parentTagId         string | If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted. |
    updatedAtTime     string | Time the vehicle was updated in RFC 3339 format. |
    vehicleRegulationMode     string | Whether the vehicle is regulated or unregulated (non-CMV). Valid values: regulated , unregulated . |
    vehicleType     string | The type of the vehicle. Only returned for customers with commercial speed limits (CSL) enabled. Valid values: unset , passenger , truck , bus . |
    vehicleWeight     integer | The weight of the vehicle in either pounds (lb) or kilograms (kg). Unit of weight is unknown. Only returned for customers with commercial speed limits (CSL) enabled. |
    vehicleWeightInKilograms     integer | The weight of the vehicle in kilograms (kg). Only returned for customers with commercial speed limits (CSL) enabled. |
    vehicleWeightInPounds     integer | The weight of the vehicle in pounds (lb). Only returned for customers with commercial speed limits (CSL) enabled. |
    vin     string | The VIN of the vehicle. |
    year     string |
Updated 2 days ago