Alert Webhook Event Schema

Suggest Edits

🚧
Versioning Update
We have released an updated version of these Alert Webhook 2.0 payloads. All previously created Webhooks will continue to use the previous payload versions across all trigger types, while any new Webhooks will use the new updated payloads documented below.
Note - An alert trigger must be included in the list of triggers below to support new Alert Webhook 2.0 payloads.

Alert incidents can trigger an alert incident webhook payload 2.0 to be sent to a desired webhook address. These alert incidents are triggered by the alerts that you have configured in the Samsara dashboard. See the Alerts Webhook guide for more details on creating and configuring webhook 2.0 in alerts.

Below documents the alert triggers and supported webhook 2.0 payloads.

Alert Incident Webhook Payload

All alert incident webhook 2.0 payloads follow a similar structure:

Example

{
  "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
  "eventTime": "1970-01-20T06:39:05.683Z",
  "eventType": "AlertIncident",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "configurationId": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
    "happenedAtTime": "2019-06-13T19:08:25Z",
    "resolvedAtTime": "2019-06-13T19:08:25Z",
    "updatedAtTime": "2019-06-13T19:08:25Z",
    "incidentUrl": "cloud.samsara.com",
    "isResolved": true,
    "conditions": [
      {
        "description": "Alert name",
        "details": {
          "geofenceEntry": {
            "driver": {
              "attributes": [
                {
                  "id": "123a",
                  "name": "JobID",
                  "numberValues": [10, 817, 92],
                  "stringValues": ["w92", "0052f-43", "abc"]
                },
                {
                  "id": "123a",
                  "name": "JobID",
                  "numberValues": [10, 817, 92],
                  "stringValues": ["w92", "0052f-43", "abc"]
                },
                {
                  "id": "123a",
                  "name": "JobID",
                  "numberValues": [10, 817, 92],
                  "stringValues": ["w92", "0052f-43", "abc"]
                }
              ],
              "externalIds": {
                "payrollId": "ABFS18600"
              },
              "id": "45646",
              "name": "Driver Bob",
              "tags": [
                {
                  "id": "3914",
                  "name": "East Coast",
                  "parentTagId": "4815"
                },
                {
                  "id": "3914",
                  "name": "East Coast",
                  "parentTagId": "4815"
                },
                {
                  "id": "3914",
                  "name": "East Coast",
                  "parentTagId": "4815"
                },
                {
                  "id": "3914",
                  "name": "East Coast",
                  "parentTagId": "4815"
                }
              ]
            },
            "vehicle": {
              "attributes": [
                {
                  "id": "494123",
                  "name": "Compliance/ELD",
                  "numberValues": [867, 5309],
                  "stringValues": ["HQ", "Leased"]
                },
                {
                  "id": "494123",
                  "name": "Compliance/ELD",
                  "numberValues": [867, 5309],
                  "stringValues": ["HQ", "Leased"]
                }
              ],
              "externalIds": {
                "maintenanceId": "250020"
              },
              "id": "494123",
              "name": "Fleet Truck #1",
              "serial": "GFRV-43N-VGX",
              "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"
                },
                {
                  "id": "3914",
                  "name": "East Coast",
                  "parentTagId": "4815"
                }
              ]
            }
          }
        },
        "triggerId": 5016
      }
    ]
  }
}

Base Reference

Property Name	Description
configurationId string	Unique ID of alert configuration.
happenedAtTime string	Time and date that the alert incident occurred in RFC 3339.
resolvedAtTime string	Time and date that the alert incident was resolved in RFC 3339.
updatedAtTime string	Time and date that the alert incident data was last updated in RFC 3339.
incidentUrl string	Url of alert incident in the cloud dashboard.
isResolved boolean	Indicates whether the incident is resolved or not.
conditions object array	An array of conditions associated with the incident.
description string	Descriptive name of the condition.
details object	Unique object representing the granular details of the condition. This object will have trigger specific field nested inside.
triggerId integer	Unique identifier describing the type of condition being represented.

The details object will vary depending on the trigger conditions of the incident. The below Generic Details Object Reference table shows the generic fields that may be supported for a given condition. See the “Details Object Reference” of each trigger in the complete list below for the specific Details Object schema.

Generic Details Object Reference

Property Name	Description
cameraDevice object	The camera associated with the alert. This string is only returned if the alert has a workforce camera associated with the event.
driver object	A driver associated with the alert. This object is only returned if the alert has a driver associated with the event.
attributes object array	[beta] Attributes associated with this entity.
id string	The Samsara ID of the attribute
name string	The name of the attribute
numberValues number array	Number values that are associated with this attribute
stringValues string array	String values that are associated with this attribute
externalIds object	A map of external ids
id string	ID of the driver
name string	Name of the driver
tags object array	The list of tags associated with the Driver.
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.
machineInput object	The machine input associated with the alert. This string is only returned if the alert has machine input associated with the event.
sensor object	The sensor associated with the alert. This object is only returned if the alert has a sensor associated with the event.
cameraStream object	The camera stream associated with the alert. This object is only returned if the alert has a stream associated with the event.
trailer object	A trailer associated with with the alert. This object is only returned if the alert has a trailer associated with the event. Note: Triggers that apply to drivers do no support trailer details in the payload
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.
externalIds object	A map of external ids
id string	The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed.
name string	The human-readable name of the Trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.
tags object array	The list of tags associated with the Trailer.
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.
trailerSerialNumber string	The serial number of the trailer.
vehicle object	A vehicle associated with the alert. This object is only returned if the alert has a vehicle associated with the event. Note: Triggers that apply to drivers do no support vehicle details in the payload
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.
externalIds object	A map of external ids
id string	ID of the vehicle
name string	Name of the vehicle
serial string	The serial number of the gateway installed on the asset.
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.

🚧Versioning Update

Alert Incident Webhook Payload

Example

Base Reference

Generic Details Object Reference

Ambient Temperature

Details Object Reference

Example

Asset Engine Off

Details Object Reference

Example

Asset Engine On

Details Object Reference

Example

Asset starts moving

Details Object Reference

Example

Asset stops moving

Details Object Reference

Example

Camera Connector Disconnected

Details Object Reference

Example

Camera Stream Issue

Details Object Reference

Example

Cell Signal Loss

Details Object Reference

Example

Cloud Backup Upload Issue

Details Object Reference

Example

Dashcam Disconnected

Details Object Reference

Example

DVIR Submitted for Asset

Details Object Reference

Example

Data Input Value

Details Object Reference

Example

Driver Action - Message Sent

Details Object Reference

Example

Driver App Sign In

Details Object Reference

Example

Driver App Sign Out

Details Object Reference

Example

[Beta] Driver Document Submitted

Details Object Reference

Example

Driver HOS Violation

Details Object Reference

Example

Driver Message Received

Details Object Reference

Example

[Beta] Form Submitted

Details Object Reference

Example

Fuel Level (Percentage)

Details Object Reference

Example

GPS Signal Loss

Details Object Reference

Example

Gateway Disconnected

Details Object Reference

Example

[Beta] Gateway Unplugged

Details Object Reference

Example

[Beta] Geofence Entry

Details Object Reference

Example

[Beta] Geofence Exit

Details Object Reference

Example

🚧
Versioning Update