[Beta] DocumentSubmitted Event Schema

[Beta] DocumentSubmitted Webhook Payload

Example

{
    "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
    "eventTime": "1970-01-20T06:39:05.683Z",
    "eventType": "DocumentSubmitted",
    "orgId": 20936,
    "webhookId": "1411751028848270",
    "data": {
        "document": {
            "conditionalFieldSections": [
                {
                    "conditionalFieldFirstIndex": 5083143870897228000,
                    "conditionalFieldLastIndex": 2770896918544835600,
                    "triggeringFieldIndex": 8389989517472915000,
                    "triggeringFieldValue": "Optiona 1"
                },
                {
                    "conditionalFieldFirstIndex": 5083143870897228000,
                    "conditionalFieldLastIndex": 2770896918544835600,
                    "triggeringFieldIndex": 8389989517472915000,
                    "triggeringFieldValue": "Optiona 1"
                },
                {
                    "conditionalFieldFirstIndex": 5083143870897228000,
                    "conditionalFieldLastIndex": 2770896918544835600,
                    "triggeringFieldIndex": 8389989517472915000,
                    "triggeringFieldValue": "Optiona 1"
                }
            ],
            "createdAtTime": "1976-03-06T08:22:53Z",
            "documentType": {
                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                "name": "Fleet Truck List"
            },
            "fields": [
                {
                    "label": "Load weight",
                    "type": "photo",
                    "value": {
                        "barcodeValue": [
                            {
                                "barcodeType": "org.gs1.EAN-13",
                                "barcodeValue": "0853883003114"
                            },
                            {
                                "barcodeType": "org.gs1.EAN-13",
                                "barcodeValue": "0853883003114"
                            },
                            {
                                "barcodeType": "org.gs1.EAN-13",
                                "barcodeValue": "0853883003114"
                            },
                            {
                                "barcodeType": "org.gs1.EAN-13",
                                "barcodeValue": "0853883003114"
                            }
                        ],
                        "dateTimeValue": {
                            "dateTime": "1984-10-23T07:14:29Z"
                        },
                        "multipleChoiceValue": [
                            {
                                "selected": false,
                                "value": "Yes"
                            },
                            {
                                "selected": false,
                                "value": "Yes"
                            },
                            {
                                "selected": false,
                                "value": "Yes"
                            }
                        ],
                        "numberValue": 123.456,
                        "photoValue": [
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            },
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            }
                        ],
                        "scannedDocumentValue": [
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            },
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            },
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            }
                        ],
                        "signatureValue": {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "name": "John Smith",
                            "signedAtTime": "1996-01-30T06:14:20Z",
                            "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                        },
                        "stringValue": "Red Truck"
                    }
                },
                {
                    "label": "Load weight",
                    "type": "photo",
                    "value": {
                        "barcodeValue": [
                            {
                                "barcodeType": "org.gs1.EAN-13",
                                "barcodeValue": "0853883003114"
                            },
                            {
                                "barcodeType": "org.gs1.EAN-13",
                                "barcodeValue": "0853883003114"
                            },
                            {
                                "barcodeType": "org.gs1.EAN-13",
                                "barcodeValue": "0853883003114"
                            },
                            {
                                "barcodeType": "org.gs1.EAN-13",
                                "barcodeValue": "0853883003114"
                            }
                        ],
                        "dateTimeValue": {
                            "dateTime": "1984-10-23T07:14:29Z"
                        },
                        "multipleChoiceValue": [
                            {
                                "selected": false,
                                "value": "Yes"
                            },
                            {
                                "selected": false,
                                "value": "Yes"
                            },
                            {
                                "selected": false,
                                "value": "Yes"
                            }
                        ],
                        "numberValue": 123.456,
                        "photoValue": [
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            },
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            }
                        ],
                        "scannedDocumentValue": [
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            },
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            },
                            {
                                "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
                                "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                            }
                        ],
                        "signatureValue": {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "name": "John Smith",
                            "signedAtTime": "1996-01-30T06:14:20Z",
                            "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
                        },
                        "stringValue": "Red Truck"
                    }
                }
            ],
            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
            "name": "Dropoff Slip 123",
            "notes": "Missing a crate",
            "route": {
                "externalIds": {
                    "maintenanceId": "250020",
                    "payrollId": "ABFS18600"
                },
                "id": "131313",
                "name": "Pineapple delivery"
            },
            "routeStop": {
                "externalIds": {
                    "maintenanceId": "250020",
                    "payrollId": "ABFS18600"
                },
                "id": "494123",
                "name": "Company Warehouse #1"
            },
            "state": "submitted",
            "updatedAtTime": "2009-01-10T02:28:18Z"
        },
        "driver": {
            "externalIds": {
                "maintenanceId": "250020",
                "payrollId": "ABFS18600"
            },
            "id": "45646",
            "name": "Driver Bob"
        },
        "vehicle": {
            "externalIds": {
                "maintenanceId": "250020",
                "payrollId": "ABFS18600"
            },
            "gateway": {
                "model": "VG34",
                "serial": "GFRV-43N-VGX"
            },
            "id": "494123",
            "licensePlate": "6SAM123",
            "name": "Fleet Truck #1",
            "vin": "1GBJ6P1B2HV112765"
        }
    }
}

Reference

Property NameDescription
document
object
A single document.
    conditionalFieldSections
    object array
List of the document conditional field sections.
        conditionalFieldFirstIndex
        integer
The index of the first conditional field associated with the triggeringFieldValue in the fieldTypes list.
        conditionalFieldLastIndex
        integer
The index of the last conditional field associated with the triggeringFieldValue in the fieldTypes list.
        triggeringFieldIndex
        integer
The index of the multiple choice field in the fieldTypes list that triggers one or more conditional fields.
        triggeringFieldValue
        string
The multiple choice option value that triggers the conditional fields.
    createdAtTime
    string
Time the document was created in RFC 3339 format.
    documentType
    object
A minified document type object
        id
        string
ID of the document type.
        name
        string
Name of the document type.
    fields
    object array
The fields associated with this document.
        label
        string
The name of the field.
        type
        string
The type of field. Valid values: photo, string, number, multipleChoice, signature, dateTime, scannedDocument, barcode.
        value
        object
The value of the document field. The shape of value depends on the type.
            barcodeValue
            object array
The value of a barcode scanning field. Only present for barcode scanning fields.
                barcodeType
                string
The barcode type that was scanned.
                barcodeValue
                string
The captured barcode value.
            dateTimeValue
            object
The value of a date time field. Only present for date time fields.
                dateTime
                string
Date time value inin RFC 3339 format.
            multipleChoiceValue
            object array
The value of a multiple choice field. Only present for multiple choice fields.
                selected
                boolean
Boolean representing if the choice has been selected.
                value
                string
Description of the choice.
            numberValue
            number
The value of a number field. Only present for number fields.
            photoValue
            object array
The value of a photo field. Only present for photo fields.
                id
                string
Id of the photo.
                url
                string
Url of the photo.
            scannedDocumentValue
            object array
The value of a scanned document field. Only present for scanned document fields.
                id
                string
Id of the scanned document.
                url
                string
Url of the scanned document.
            signatureValue
            object
The value of a signature field. Only present for signature fields.
                id
                string
Id of the signature field.
                name
                string
Name of the signee for a signature field.
                signedAtTime
                string
Time the signature was captured in RFC 3339 format.
                url
                string
Url of a signature field's PNG signature image.
            stringValue
            string
The value of a string field. Only present for string fields.
    id
    string
Universally unique identifier for the document.
    name
    string
Name of the document.
    notes
    string
Notes on the document.
    route
    object
A minified representation of a single route.
        externalIds
        object
A map of external ids
        id
        string
Unique identifier for the route.
        name
        string
Name of the route.
    routeStop
    object
A minified route stop object
        externalIds
        object
A map of external ids
        id
        string
Id of the route stop
        name
        string
Name of the route stop
    state
    string
The condition of the document created for the driver. Can be either Required or Submitted. Required documents are pre-populated documents for the Driver to fill out in the Driver App and have not yet been submitted. Submitted documents have been submitted by the driver in the Driver App. Archived documents have been archived by the admin in the cloud dashboard. Valid values: submitted, required, archived.
    updatedAtTime
    string
Time the document was updated in RFC 3339 format.
driver
object
A minified driver object
    externalIds
    object
A map of external ids
    id
    string
ID of the driver
    name
    string
Name of the driver
vehicle
object
A vehicle object
    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, AG51, AG51EU, AG52, AG52EU, IG15, IG21, IG41, IG61, SG1, VG32, VG33, VG34, VG34EU, VG34FN, VG54EU, VG54NA.
        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.