DvirSubmitted Webhook Payload

Example

{
    "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
    "eventTime": "1970-01-20T06:39:05.683Z",
    "eventType": "DvirSubmitted",
    "orgId": 20936,
    "webhookId": "1411751028848270",
    "data": {
        "driver": {
            "externalIds": {
                "payrollId": "ABFS18600"
            },
            "id": "45646",
            "name": "Driver Bob"
        },
        "dvir": {
            "authorSignature": {
                "signatoryUser": {
                    "id": "938172",
                    "name": "Joe Driver"
                },
                "signedAtTime": "2020-01-27T07:06:25Z",
                "type": "driver"
            },
            "defects": [
                {
                    "comment": "Air compressor not working",
                    "createdAtTime": "2020-01-27T07:06:25Z",
                    "defectSeverity": "minor",
                    "defectType": "Air Compressor",
                    "defectTypeId": "550e8400-e29b-41d4-a716-446655440000",
                    "id": "18",
                    "isResolved": false,
                    "mechanicNotes": "Extremely large oddly shaped hole in passenger side window.",
                    "mechanicNotesUpdatedAtTime": "2020-01-27T07:06:25Z",
                    "resolvedAtTime": "2020-01-27T07:06:25Z",
                    "resolvedBy": {
                        "id": "8172",
                        "name": "Jane Mechanic",
                        "type": "mechanic"
                    },
                    "trailer": {
                        "externalIds": {
                            "maintenanceId": "250020"
                        },
                        "id": "494123",
                        "name": "Fleet Truck #1"
                    },
                    "vehicle": {
                        "assetType": "vehicle",
                        "externalIds": {
                            "maintenanceId": "250020"
                        },
                        "gateway": {
                            "model": "VG34",
                            "serial": "GFRV-43N-VGX"
                        },
                        "id": "494123",
                        "licensePlate": "6SAM123",
                        "name": "Fleet Truck #1",
                        "vin": "1GBJ6P1B2HV112765"
                    }
                }
            ],
            "endTime": "2020-01-27T07:06:25Z",
            "formattedLocation": "350 Rhode Island St Ste. 400S, San Francisco, CA 94103",
            "hasDefects": false,
            "id": "12345",
            "mechanicNotes": "Replaced headlight on passenger side.",
            "needsCorrection": false,
            "odometerMeters": 91823,
            "safetyStatus": "unsafe",
            "secondSignature": {
                "signatoryUser": {
                    "id": "938172",
                    "name": "Joe Driver"
                },
                "signedAtTime": "2020-01-27T07:06:25Z",
                "type": "driver"
            },
            "startTime": "2020-01-27T07:06:25Z",
            "thirdSignature": {
                "signatoryUser": {
                    "id": "938172",
                    "name": "Joe Driver"
                },
                "signedAtTime": "2020-01-27T07:06:25Z",
                "type": "driver"
            },
            "trailer": {
                "externalIds": {
                    "maintenanceId": "250020"
                },
                "id": "494123",
                "name": "Fleet Truck #1"
            },
            "type": "mechanic"
        },
        "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 Name	Description
driver object	A minified driver object. This object is only returned if the route is assigned to the driver.
externalIds object	A map of external ids
id string	ID of the driver
name string	Name of the driver
dvir object	A DVIR description
authorSignature object	An author signature for DVIRs with a signed time.
signatoryUser object	The user who signed the DVIR.
id string	ID of the user.
name string	Name of the user.
signedAtTime string	The time when the DVIR was signed. UTC timestamp in RFC 3339 format.
type string	Whether the DVIR was submitted by a driver or mechanic. Valid values: `driver`, `mechanic`.
defects object array	Defects registered for the DVIR.
comment string	Comment on the defect.
createdAtTime string	Time when the defect was created. UTC timestamp in RFC 3339 format.
defectSeverity string	The severity of the DVIR defect. Valid values: `minor`, `major`, `unspecified`.
defectType string	The type of DVIR defect.
defectTypeId string	The ID of the DVIR defect type.
id string	The ID of the defect.
isResolved boolean	Signifies if this defect is resolved.
mechanicNotes string	The mechanic notes on this defect.
mechanicNotesUpdatedAtTime string	Time when mechanic notes were last updated. UTC timestamp in RFC 3339 format.
resolvedAtTime string	Time when this defect was resolved. Will not be returned if the defect is unresolved. UTC timestamp in RFC 3339 format.
resolvedBy object	The person who resolved this defect.
id string	ID of the entity that resolved this defect. If the defect was resolved by a driver, this will be a Samsara Driver ID. If the defect was resolved by a mechanic, this will be the Samsara Dashboard User ID of the mechanic.
name string	Name of the person who resolved this defect.
type string	Indicates whether this defect was resolved by a driver or a mechanic. Valid values: `driver`, `mechanic`.
trailer object	A minified trailer object
externalIds object	A map of external ids
id string	ID of the trailer
name string	Name of the trailer
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.
endTime string	Time when the driver signed and completed this DVIR. UTC timestamp in RFC 3339 format.
formattedLocation string	Optional string if your jurisdiction requires a location of the DVIR.
hasDefects boolean	Indicates if a new defect is present on the DVIR.
id string	The unique id of the DVIR
mechanicNotes string	The mechanics notes on the DVIR.
needsCorrection boolean	Indicates if a defect needs correction.
odometerMeters integer	The odometer reading in meters.
safetyStatus string	The condition of vehicle on which DVIR was done. Valid values: `safe`, `unsafe`, `resolved`.
secondSignature object	[deprecated] An author signature for DVIRs with a signed time. This field is deprecated, do not use it. It's always empty.
signatoryUser object	The user who signed the DVIR.
id string	ID of the user.
name string	Name of the user.
signedAtTime string	The time when the DVIR was signed. UTC timestamp in RFC 3339 format.
type string	Whether the DVIR was submitted by a driver or mechanic. Valid values: `driver`, `mechanic`.
startTime string	Time when driver began filling out this DVIR in RFC 3339 format.
thirdSignature object	[deprecated] An author signature for DVIRs with a signed time. This field is deprecated, do not use it. It's always empty.
signatoryUser object	The user who signed the DVIR.
id string	ID of the user.
name string	Name of the user.
signedAtTime string	The time when the DVIR was signed. UTC timestamp in RFC 3339 format.
type string	Whether the DVIR was submitted by a driver or mechanic. Valid values: `driver`, `mechanic`.
trailer object	A minified trailer object
externalIds object	A map of external ids
id string	ID of the trailer
name string	Name of the trailer
type string	Inspection type of the DVIR. Valid values: `preTrip`, `postTrip`, `mechanic`, `unspecified`.
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.