[Beta] FormSubmitted Event Schema

[Beta] FormSubmitted Webhook Payload

Example

{
    "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
    "eventTime": "1970-01-20T06:39:05.683Z",
    "eventType": "FormSubmitted",
    "orgId": 20936,
    "webhookId": "1411751028848270",
    "data": {
        "form": {
            "asset": {
                "entryType": "tracked",
                "id": "281474982859091",
                "name": "trailer 123"
            },
            "assignedAtTime": "2019-06-13T19:08:25Z",
            "assignedTo": {
                "id": "938172",
                "type": "driver"
            },
            "createdAtTime": "2019-06-13T19:08:25Z",
            "dueAtTime": "2019-06-13T19:08:25Z",
            "externalIds": {
                "maintenanceId": "250020"
            },
            "fields": [
                {
                    "assetValue": {
                        "asset": {
                            "entryType": "tracked",
                            "id": "281474982859091",
                            "name": "trailer 123"
                        }
                    },
                    "checkBoxesValue": {
                        "value": [
                            "One",
                            "Two",
                            "Three",
                            "Four"
                        ]
                    },
                    "dateTimeValue": {
                        "type": "datetime",
                        "value": "2019-06-13T19:08:25Z"
                    },
                    "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                    "issue": {
                        "externalIds": {
                            "maintenanceId": "250020"
                        },
                        "id": "12345"
                    },
                    "label": "Engine Hours",
                    "mediaList": [
                        {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        },
                        {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        }
                    ],
                    "mediaValue": {
                        "mediaList": [
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            }
                        ]
                    },
                    "multipleChoiceValue": {
                        "value": "Yes"
                    },
                    "note": "Fire and oil can lead to an accident.",
                    "numberValue": {
                        "value": 123.456
                    },
                    "personValue": {
                        "person": {
                            "entryType": "tracked",
                            "name": "Jake",
                            "polymorphicUserId": {
                                "id": "938172",
                                "type": "driver"
                            }
                        }
                    },
                    "signatureValue": {
                        "media": {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        }
                    },
                    "textValue": {
                        "value": "Exposed wires"
                    },
                    "type": "number"
                },
                {
                    "assetValue": {
                        "asset": {
                            "entryType": "tracked",
                            "id": "281474982859091",
                            "name": "trailer 123"
                        }
                    },
                    "checkBoxesValue": {
                        "value": [
                            "One",
                            "Two",
                            "Three",
                            "Four"
                        ]
                    },
                    "dateTimeValue": {
                        "type": "datetime",
                        "value": "2019-06-13T19:08:25Z"
                    },
                    "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                    "issue": {
                        "externalIds": {
                            "maintenanceId": "250020"
                        },
                        "id": "12345"
                    },
                    "label": "Engine Hours",
                    "mediaList": [
                        {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        },
                        {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        }
                    ],
                    "mediaValue": {
                        "mediaList": [
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            }
                        ]
                    },
                    "multipleChoiceValue": {
                        "value": "Yes"
                    },
                    "note": "Fire and oil can lead to an accident.",
                    "numberValue": {
                        "value": 123.456
                    },
                    "personValue": {
                        "person": {
                            "entryType": "tracked",
                            "name": "Jake",
                            "polymorphicUserId": {
                                "id": "938172",
                                "type": "driver"
                            }
                        }
                    },
                    "signatureValue": {
                        "media": {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        }
                    },
                    "textValue": {
                        "value": "Exposed wires"
                    },
                    "type": "number"
                },
                {
                    "assetValue": {
                        "asset": {
                            "entryType": "tracked",
                            "id": "281474982859091",
                            "name": "trailer 123"
                        }
                    },
                    "checkBoxesValue": {
                        "value": [
                            "One",
                            "Two",
                            "Three",
                            "Four"
                        ]
                    },
                    "dateTimeValue": {
                        "type": "datetime",
                        "value": "2019-06-13T19:08:25Z"
                    },
                    "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                    "issue": {
                        "externalIds": {
                            "maintenanceId": "250020"
                        },
                        "id": "12345"
                    },
                    "label": "Engine Hours",
                    "mediaList": [
                        {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        },
                        {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        }
                    ],
                    "mediaValue": {
                        "mediaList": [
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            }
                        ]
                    },
                    "multipleChoiceValue": {
                        "value": "Yes"
                    },
                    "note": "Fire and oil can lead to an accident.",
                    "numberValue": {
                        "value": 123.456
                    },
                    "personValue": {
                        "person": {
                            "entryType": "tracked",
                            "name": "Jake",
                            "polymorphicUserId": {
                                "id": "938172",
                                "type": "driver"
                            }
                        }
                    },
                    "signatureValue": {
                        "media": {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        }
                    },
                    "textValue": {
                        "value": "Exposed wires"
                    },
                    "type": "number"
                },
                {
                    "assetValue": {
                        "asset": {
                            "entryType": "tracked",
                            "id": "281474982859091",
                            "name": "trailer 123"
                        }
                    },
                    "checkBoxesValue": {
                        "value": [
                            "One",
                            "Two",
                            "Three",
                            "Four"
                        ]
                    },
                    "dateTimeValue": {
                        "type": "datetime",
                        "value": "2019-06-13T19:08:25Z"
                    },
                    "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                    "issue": {
                        "externalIds": {
                            "maintenanceId": "250020"
                        },
                        "id": "12345"
                    },
                    "label": "Engine Hours",
                    "mediaList": [
                        {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        },
                        {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        }
                    ],
                    "mediaValue": {
                        "mediaList": [
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            },
                            {
                                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                                "processingStatus": "processing",
                                "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                                "urlExpiresAt": "2019-06-13T19:08:25Z"
                            }
                        ]
                    },
                    "multipleChoiceValue": {
                        "value": "Yes"
                    },
                    "note": "Fire and oil can lead to an accident.",
                    "numberValue": {
                        "value": 123.456
                    },
                    "personValue": {
                        "person": {
                            "entryType": "tracked",
                            "name": "Jake",
                            "polymorphicUserId": {
                                "id": "938172",
                                "type": "driver"
                            }
                        }
                    },
                    "signatureValue": {
                        "media": {
                            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                            "processingStatus": "processing",
                            "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                            "urlExpiresAt": "2019-06-13T19:08:25Z"
                        }
                    },
                    "textValue": {
                        "value": "Exposed wires"
                    },
                    "type": "number"
                }
            ],
            "formTemplate": {
                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                "revisionId": "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7"
            },
            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
            "isRequired": true,
            "location": {
                "latitude": 12333122.3,
                "longitude": 1233331.4
            },
            "score": {
                "maxPoints": 80,
                "scorePercent": 75,
                "scorePoints": 60
            },
            "status": "toDo",
            "submittedAtTime": "2019-06-13T19:08:25Z",
            "submittedBy": {
                "id": "938172",
                "type": "driver"
            },
            "title": "Form Submission Title",
            "updatedAtTime": "2019-06-13T19:08:25Z"
        }
    }
}

Reference

Property NameDescription
form
object
Form Submission response object.
    asset
    object
Tracked or untracked (i.e. manually entered) asset object.
        entryType
        string
The type of entry for the asset. Valid values: tracked, untracked.
        id
        string
ID of a tracked asset. Included if 'entryType' is 'tracked'.
        name
        string
Name of an untracked (i.e. manually entered) asset.
    assignedAtTime
    string
Assignment time of the form submission. Sometimes returned if the submission was assigned to a user or driver. UTC timestamp in RFC 3339 format.
    assignedTo
    object
User or driver object.
        id
        string
ID of the polymorphic user.
        type
        string
The type of the polymorphic user. Valid values: driver, user.
    createdAtTime
    string
Creation time of the form submission. UTC timestamp in RFC 3339 format.
    dueAtTime
    string
Time of when the submission is due. Sometimes returned, if the submission has a due date. UTC timestamp in RFC 3339 format.
    externalIds
    object
A map of external ids
    fields
    object array
List of field inputs in a form submission.
        assetValue
        object
The value of an asset form input field. Only present for asset form input fields.
            asset
            object
Tracked or untracked (i.e. manually entered) asset object.
                entryType
                string
The type of entry for the asset. Valid values: tracked, untracked.
                id
                string
ID of a tracked asset. Included if 'entryType' is 'tracked'.
                name
                string
Name of an untracked (i.e. manually entered) asset.
        checkBoxesValue
        object
The value of a check boxes form input field. Only present for check boxes form input fields.
            value
            string array
        dateTimeValue
        object
The value of a datetime form input field. Only present for datetime form input fields.
            type
            string
The type of datetime format. Valid values: datetime, date, time.
            value
            string
The value of the user generated date/time field response. UTC timestamp in RFC 3339 format.
        id
        string
ID of the forms input field object.
        issue
        object
Issue created from this form input field input object.
            externalIds
            object
A map of external ids
            id
            string
ID of the issue created from this form input field input object.
        label
        string
Forms input field label.
        mediaList
        object array
List of forms media record objects.
            id
            string
ID of the media record.
            processingStatus
            string
Status of the media record. Valid values: unknown, processing, finished.
            url
            string
URL containing a link to associated media content. Included if 'processingStatus' is 'finished'.
            urlExpiresAt
            string
Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format.
        mediaValue
        object
The value of a media form input field. Only present for media form input fields.
            mediaList
            object array
List of forms media record objects.
                id
                string
ID of the media record.
                processingStatus
                string
Status of the media record. Valid values: unknown, processing, finished.
                url
                string
URL containing a link to associated media content. Included if 'processingStatus' is 'finished'.
                urlExpiresAt
                string
Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format.
        multipleChoiceValue
        object
The value of a multiple choice form input field. Only present for multiple choice form input fields.
            value
            string
        note
        string
A note attached to the field input.
        numberValue
        object
The value of a number form input field. Only present for number form input fields.
            value
            number
        personValue
        object
The value of a person form input field. Only present for person form input fields.
            person
            object
Tracked or untracked (i.e. manually entered) person object.
                entryType
                string
The type of entry for the person. Valid values: tracked, untracked.
                name
                string
Name of an untracked (i.e. manually entered) person.
                polymorphicUserId
                object
User or driver object.
                    id
                    string
ID of the polymorphic user.
                    type
                    string
The type of the polymorphic user. Valid values: driver, user.
        signatureValue
        object
The value of a signature form input field. Only present for signature form input fields.
            media
            object
Forms media record object.
                id
                string
ID of the media record.
                processingStatus
                string
Status of the media record. Valid values: unknown, processing, finished.
                url
                string
URL containing a link to associated media content. Included if 'processingStatus' is 'finished'.
                urlExpiresAt
                string
Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format.
        textValue
        object
The value of a text form input field. Only present for text form input fields.
            value
            string
        type
        string
Type of the field. Valid values: number, text, multiple_choice, check_boxes, datetime, signature, media, asset.
    formTemplate
    object
Form template reference object.
        id
        string
ID of the form template.
        revisionId
        string
ID of the form template revision.
    id
    string
ID of the form submission.
    isRequired
    boolean
Indicates whether the worker is required to complete this form or not. Sometimes returned if the submission was assigned to a user or driver.
    location
    object
Form template location object.
        latitude
        number
Latitude of a location.
        longitude
        number
Longitude of a location.
    score
    object
Forms score object.
        maxPoints
        number
Total possible points of the form submission.
        scorePercent
        number
Percentage score of the form submission, calculated as scorePoints / maxPoints.
        scorePoints
        number
Score, in points, of the form submission.
    status
    string
State for the Form Submission. Always returned. Valid values: toDo, submitted, dismissed.
    submittedAtTime
    string
Submission time of the form submission. UTC timestamp in RFC 3339 format.
    submittedBy
    object
User or driver object.
        id
        string
ID of the polymorphic user.
        type
        string
The type of the polymorphic user. Valid values: driver, user.
    title
    string
Title of the form submission. Sometimes returned if the submission has a title.
    updatedAtTime
    string
Update time of the form submission. UTC timestamp in RFC 3339 format.