Skip to main content

Documentation Index

Fetch the complete documentation index at: https://samsara-showcase.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Example

{
  "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
  "eventTime": "1970-01-20T06:39:05.683Z",
  "eventType": "FormUpdated",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "form": {
      "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "title": "Vehicle Inspection",
      "status": "submitted",
      "createdAtTime": "2019-06-13T19:08:25Z",
      "submittedAtTime": "2019-06-13T19:08:25Z",
      "updatedAtTime": "2019-06-13T19:08:25Z",
      "submittedBy": {
        "id": "938172",
        "type": "driver"
      },
      "asset": {
        "entryType": "tracked",
        "id": "281474982859091",
        "name": "Trailer 123",
        "externalIds": {
          "maintenanceId": "250020"
        }
      },
      "fields": [
        {
          "id": "field-text",
          "label": "Notes",
          "type": "text",
          "textValue": {
            "value": "Exposed wires"
          }
        },
        {
          "id": "field-number",
          "label": "Engine Hours",
          "type": "number",
          "numberValue": {
            "value": 123.456
          }
        },
        {
          "id": "field-choice",
          "label": "Inspection Result",
          "type": "multipleChoice",
          "multipleChoiceValue": {
            "value": "Pass",
            "valueId": "94096370-7228-4d83-ae5d-b20f3e45c0fc"
          }
        },
        {
          "id": "field-media",
          "label": "Photo Evidence",
          "type": "media",
          "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": "field-table",
          "label": "Line Items",
          "type": "table",
          "tableValue": {
            "columns": [
              {
                "id": "field-uuid-store-number",
                "label": "Store Number",
                "type": "number"
              }
            ],
            "rows": [
              {
                "cells": [
                  {
                    "id": "field-uuid-store-number",
                    "type": "number",
                    "numberValue": {
                      "value": 123.456
                    }
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  }
}

​
Reference

Property NameDescription
form
object		Form Submission response object.
    approvalDetails
    object		The value of the approval details for a forms product submission.
        comment
        string		Comment from the approver when requesting changes or approving the submission.
    asset
    object		Tracked or untracked (i.e. manually entered) asset object.
        entryType
        string		The type of entry for the asset. Valid values: tracked, untracked.
        externalIds
        object		A map of external ids
        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.
            asset
            object		Tracked or untracked (i.e. manually entered) asset object.
                entryType
                string		The type of entry for the asset. Valid values: tracked, untracked.
                externalIds
                object		A map of external ids
                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.
            value
            string array		List of selected options.
            valueIds
            string array		List of selected option IDs.
        dateTimeValue
        object		The value of a datetime form input field.
            dateValue
            string		Calendar date in YYYY-MM-DD format in the stored field timezone. Present when type is date (date-only fields).
            type
            string		The type of datetime format. Valid values: datetime, date, time.
            value
            string		UTC timestamp in RFC 3339 format.
        geofenceValue
        object		The value of a geofence form input field.
            geofence
            object		Tracked or untracked (i.e. manually entered) geofence object.
                address
                string		Address of the geofence. Included if ‘entryType’ is tracked.
                entryType
                string		The type of entry for the geofence. Valid values: tracked, untracked.
                externalIds
                object		A map of external ids
                id
                string		ID of the tracked geofence. Included if ‘entryType’ is tracked.
                name
                string		Name of an untracked (i.e. manually entered) geofence.
        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.
            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.
            value
            string		Selected option.
            valueId
            string		ID of the selected option.
        note
        string		A note attached to the field input.
        numberValue
        object		The value of a number form input field.
            value
            number		Number value.
        personValue
        object		The value of a person form input field.
            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.
            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.
        tableValue
        object		The value of a table form input field.
            columns
            object array		List of table columns.
                id
                string		Unique identifier for the column.
                label
                string		Label of the column.
                type
                string		Type of the column field. Valid values: text, number, datetime, check_boxes, multiple_choice, signature, media, person.
            rows
            object array		List of table rows.
                cells
                object array		List of cells in the row.
                    checkBoxesValue
                    object		The value of a check boxes form input field.
                        value
                        string array		List of selected options.
                        valueIds
                        string array		List of selected option IDs.
                    dateTimeValue
                    object		The value of a datetime form input field.
                        dateValue
                        string		Calendar date in YYYY-MM-DD format in the stored field timezone. Present when type is date (date-only fields).
                        type
                        string		The type of datetime format. Valid values: datetime, date, time.
                        value
                        string		UTC timestamp in RFC 3339 format.
                    id
                    string		Unique identifier for the cell.
                    mediaValue
                    object		The value of a media form input field.
                        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.
                        value
                        string		Selected option.
                        valueId
                        string		ID of the selected option.
                    numberValue
                    object		The value of a number form input field.
                        value
                        number		Number value.
                    personValue
                    object		The value of a person form input field.
                        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.
                        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.
                        value
                        string		Text value.
                    type
                    string		Type of the cell field. Valid values: number, text, multiple_choice, check_boxes, datetime, signature, media, person.
                id
                string		Unique identifier for the row.
        textValue
        object		The value of a text form input field.
            value
            string		Text value.
        type
        string		Type of the field. Valid values: number, text, multiple_choice, check_boxes, datetime, signature, media, asset, table, person, geofence.
    formTemplate
    object		Form template reference object.
        id
        string		ID of the form template.
        revisionId
        string		ID of the form template revision.
    geofence
    object		Tracked or untracked (i.e. manually entered) geofence object.
        address
        string		Address of the geofence. Included if ‘entryType’ is tracked.
        entryType
        string		The type of entry for the geofence. Valid values: tracked, untracked.
        externalIds
        object		A map of external ids
        id
        string		ID of the tracked geofence. Included if ‘entryType’ is tracked.
        name
        string		Name of an untracked (i.e. manually entered) geofence.
    id
    string		ID of the form submission.
    isRequired
    boolean		Indicates whether the worker is required to complete this form or not. Always returned.
    location
    object		Form template location object.
        latitude
        number		Latitude of a location.
        longitude
        number		Longitude of a location.
    routeId
    string		ID of the route. Sometimes returned if the submission was assigned to a route stop.
    routeStopId
    string		ID of the route stop. Sometimes returned if the submission was assigned to a route stop.
    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: notStarted, completed, archived, inProgress, needsReview, changesRequested, approved.
    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.