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.

Submit Feedback. We are always open to product feedback — whether it’s more webhooks you want to see, enhancements to existing webhooks, or anything webhooks related! Submit feedback here.

Alert Events

Alert events primarily trigger webhook notifications. These events are triggered by the alerts you have configured in the Samsara dashboard. See the Webhooks guide for more details on creating and configuring alerts. An event with an eventType of Alert has the following fields:
FieldDescription
alertEventUrlA link to the alert in the Samsara dashboard.
alertConditionDescriptionA human-readable string describing the condition that triggered the alert.
alertConditionIdThe ID of the condition that triggered the alert. Indicates the alert type.
detailsA human-readable string with dynamic details on the alert.
orgIdThe ID of your organization. Helpful in debugging when contacting support.
resolvedWhether the alert has been resolved. Always false in a webhook notification.
startMsUnix epoch timestamp of when the event was triggered (from the gateway, mobile device, or originating cloud service). Different from eventMs.
summaryA brief summary of the event.
Additional fieldsDepending on the alert type, additional fields may be available.
Example payload:
{
  "eventId": "bf72239c-bebd-4c22-b64c-6fc692ef7c46",
  "eventMs": 1587597109477,
  "eventType": "Alert",
  "event": {
    "alertEventUrl": "https://cloud.samsara.com/o/53729/alerts/incidents/v2/159827/1/212014918732717/1587596963539/link?dl=...",
    "alertConditionDescription": "Vehicle is inside geofence",
    "alertConditionId": "DeviceLocationInsideGeofence",
    "details": "'Little Red' is inside Parent's House.",
    "orgId": 53729,
    "resolved": false,
    "startMs": 1587596963539,
    "summary": "'Little Red' is inside Parent's House."
  }
}
The reference below documents each alert condition, the additional event fields it carries, and a representative payload. The device object — when present — always includes:
  • id (integer) — ID of the vehicle
  • name (string) — Name of the vehicle
  • serial (string) — Device serial number
  • vin (string) — VIN of the vehicle

Fault Codes

FieldValue
alertConditionIdDeviceHasVehicleFault
alertConditionDescriptionVehicle has fault
deviceVehicle device object
detailsFor J1939 vehicles, includes lamp names (stop, warning, protect, emissions) and per-fault txId, spnId, spnDescription, fmiId, fmiDescription, and occurrenceCount. For OBD-II, includes the dtc code and dtcDescription.
{
  "eventId": "e3645383-32f1-4c66-a5e6-983b2e456e77",
  "eventMs": 1600792716481,
  "eventType": "Alert",
  "event": {
    "alertConditionDescription": "Vehicle has fault",
    "alertConditionId": "DeviceHasVehicleFault",
    "details": "Vehicle 'Little Red' reported a fault. Check engine lights: warning, emissions. Vehicle faults: TxId: 11, SPN: 627 - Power Supply (obsolete), FMI: 4 (Voltage Below Normal), Count: 127.",
    "device": {
      "id": 281474977075805,
      "name": "Little Red",
      "serial": "G9MTH7CNKZ",
      "vin": "JTMBK32V895081147"
    },
    "orgId": 53729,
    "resolved": false,
    "startMs": 1600792612258,
    "summary": "Vehicle 'Little Red' reported a fault."
  }
}

Vehicle Unplugged

FieldValue
alertConditionIdDeviceUnplugged
alertConditionDescriptionGateway unplugged
deviceVehicle device object
details'{deviceName}' has been unplugged.
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DeviceUnplugged",
    "alertConditionDescription": "Gateway unplugged",
    "details": "'Little Red' has been unplugged.",
    "device": { "id": 281474977075805, "name": "Little Red", "serial": "G9MTH7CNKZ", "vin": "JTMBK32V895081147" },
    "orgId": 53729,
    "resolved": false,
    "summary": "'Little Red' has been unplugged."
  }
}

Harsh Event

FieldValue
alertConditionIdHarshEvent
alertConditionDescriptionVehicle had a harsh event
deviceVehicle device object
harshEventTypeOne of harshAcceleration, harshBraking, harshTurning, crash
harshEventUrlLink to view the event in the Samsara dashboard
harshEventLatitude / harshEventLongitudeDecimal coordinates of the event
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "HarshEvent",
    "alertConditionDescription": "Vehicle had a harsh event",
    "details": "'Little Red' had a harsh acceleration event.",
    "device": { "id": 281474977075805, "name": "Little Red", "serial": "G9MTH7CNKZ", "vin": "JTMBK32V895081147" },
    "harshEventType": "harshAcceleration",
    "harshEventUrl": "https://cloud.samsara.com/...",
    "harshEventLatitude": 37.7749,
    "harshEventLongitude": -122.4194,
    "orgId": 53729,
    "resolved": false,
    "summary": "'Little Red' had a harsh acceleration event."
  }
}

Geofence

FieldValue
alertConditionIdDeviceLocationInsideGeofence or DeviceLocationOutsideGeofence
alertConditionDescriptionVehicle is inside geofence / Vehicle is outside geofence
deviceVehicle device object
geofenceObject with id and name of the geofence
details'{deviceName}' is inside/outside '{geofenceName}'.
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DeviceLocationInsideGeofence",
    "alertConditionDescription": "Vehicle is inside geofence",
    "details": "'Little Red' is inside Parent's House.",
    "device": { "id": 212014918732717, "name": "Little Red", "serial": "G9MTH7CNKZ", "vin": "JTMBK32V895081147" },
    "geofence": { "id": 12345, "name": "Parent's House" },
    "orgId": 53729,
    "resolved": false,
    "summary": "'Little Red' is inside Parent's House."
  }
}

Document Submission

FieldValue
alertConditionIdDocumentSubmission
alertConditionDescriptionDriver submitted a document
deviceVehicle device object
driverDriver object with id and name
documentSubmitted document with id, name, and submittedAtMs
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DocumentSubmission",
    "alertConditionDescription": "Driver submitted a document",
    "details": "Driver 'Sample Driver' submitted a document.",
    "device": { "id": 281474977075805, "name": "Little Red", "serial": "G9MTH7CNKZ", "vin": "JTMBK32V895081147" },
    "driver": { "id": 12345, "name": "Sample Driver" },
    "document": { "id": 67890, "name": "Bill of Lading", "submittedAtMs": 1600792716481 },
    "orgId": 53729,
    "resolved": false,
    "summary": "Driver 'Sample Driver' submitted a document."
  }
}

Speed

FieldValue
alertConditionIdDeviceSpeedAboveSpeedLimit or DeviceSpeedAboveAbsoluteThreshold
alertConditionDescriptionVehicle is speeding
deviceVehicle device object
currentSpeedMetersPerSecondVehicle speed at the time of the alert
speedLimitMetersPerSecondPosted speed limit (for DeviceSpeedAboveSpeedLimit)
speedThresholdMetersPerSecondThreshold (for DeviceSpeedAboveAbsoluteThreshold)
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DeviceSpeedAboveSpeedLimit",
    "alertConditionDescription": "Vehicle is speeding",
    "details": "'Little Red' is speeding 78 mph in a 65 mph zone.",
    "device": { "id": 281474977075805, "name": "Little Red", "serial": "G9MTH7CNKZ", "vin": "JTMBK32V895081147" },
    "currentSpeedMetersPerSecond": 34.86,
    "speedLimitMetersPerSecond": 29.06,
    "orgId": 53729,
    "resolved": false,
    "summary": "'Little Red' is speeding 78 mph in a 65 mph zone."
  }
}

Movement

FieldValue
alertConditionIdDeviceMovement (movement detected)
deviceVehicle device object
details'{deviceName}' has started moving.
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DeviceMovement",
    "alertConditionDescription": "Vehicle is moving",
    "details": "'Little Red' has started moving.",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "orgId": 53729,
    "resolved": false,
    "summary": "'Little Red' has started moving."
  }
}

Vehicle Engine Idle

FieldValue
alertConditionIdDeviceVehicleEngineIdle
alertConditionDescriptionVehicle is idling
deviceVehicle device object
idleDurationMsDuration of idling in milliseconds
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DeviceVehicleEngineIdle",
    "alertConditionDescription": "Vehicle is idling",
    "details": "'Little Red' has been idling for 5 minutes.",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "idleDurationMs": 300000,
    "orgId": 53729,
    "resolved": false,
    "summary": "'Little Red' has been idling for 5 minutes."
  }
}

Device Battery Level

FieldValue
alertConditionIdDeviceBatteryLowVoltage
alertConditionDescriptionVehicle battery is low
deviceVehicle device object
batteryMilliVoltsBattery voltage in millivolts
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DeviceBatteryLowVoltage",
    "alertConditionDescription": "Vehicle battery is low",
    "details": "'Little Red' battery is at 11.2V.",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "batteryMilliVolts": 11200,
    "orgId": 53729,
    "resolved": false,
    "summary": "'Little Red' battery is at 11.2V."
  }
}

Dash Cam Disconnected

FieldValue
alertConditionIdDashcamDisconnected
alertConditionDescriptionDashcam disconnected from vehicle
deviceVehicle device object
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DashcamDisconnected",
    "alertConditionDescription": "Dashcam disconnected from vehicle",
    "details": "Dashcam disconnected from 'Little Red'.",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "orgId": 53729,
    "resolved": false
  }
}

Driver HOS Violation

FieldValue
alertConditionIdDriverHOSViolation
alertConditionDescriptionDriver has an HOS violation
driverDriver object with id and name
violationTypeThe HOS rule violated (e.g., shift drive, cycle, break)
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DriverHOSViolation",
    "alertConditionDescription": "Driver has an HOS violation",
    "details": "Driver 'Sample Driver' has exceeded their shift drive limit.",
    "driver": { "id": 12345, "name": "Sample Driver" },
    "violationType": "shiftDriveLimit",
    "orgId": 53729,
    "resolved": false
  }
}

Vehicle Fuel Level

FieldValue
alertConditionIdDeviceVehicleFuelLevelLow
alertConditionDescriptionVehicle fuel level is low
deviceVehicle device object
fuelLevelPercentFuel percent at time of alert
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "DeviceVehicleFuelLevelLow",
    "alertConditionDescription": "Vehicle fuel level is low",
    "details": "'Little Red' has 10% fuel remaining.",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "fuelLevelPercent": 10,
    "orgId": 53729,
    "resolved": false
  }
}

Temperature

FieldValue
alertConditionIdSensorTemperatureAboveThreshold or SensorTemperatureBelowThreshold
sensorSensor object with id and name
temperatureMilliCSensor temperature reading
temperatureThresholdMilliCConfigured threshold
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "SensorTemperatureAboveThreshold",
    "alertConditionDescription": "Sensor temperature is above threshold",
    "sensor": { "id": 22222, "name": "Reefer Sensor" },
    "temperatureMilliC": 5500,
    "temperatureThresholdMilliC": 4000,
    "orgId": 53729,
    "resolved": false
  }
}

Humidity

FieldValue
alertConditionIdSensorHumidityAboveThreshold or SensorHumidityBelowThreshold
sensorSensor object with id and name
humidityRhRelative humidity reading
humidityThresholdRhConfigured threshold
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "SensorHumidityAboveThreshold",
    "alertConditionDescription": "Sensor humidity is above threshold",
    "sensor": { "id": 22222, "name": "Warehouse Humidity" },
    "humidityRh": 78,
    "humidityThresholdRh": 60,
    "orgId": 53729,
    "resolved": false
  }
}

Connection

FieldValue
alertConditionIdSensorDisconnected
alertConditionDescriptionSensor has been disconnected
sensorSensor object with id and name
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "SensorDisconnected",
    "alertConditionDescription": "Sensor has been disconnected",
    "sensor": { "id": 22222, "name": "Reefer Sensor" },
    "orgId": 53729,
    "resolved": false
  }
}

Vehicle Battery

FieldValue
alertConditionIdSensorBatteryLow
alertConditionDescriptionSensor battery is low
sensorSensor object with id and name
batteryMilliVoltsBattery voltage
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "SensorBatteryLow",
    "alertConditionDescription": "Sensor battery is low",
    "sensor": { "id": 22222, "name": "Door Sensor" },
    "batteryMilliVolts": 2100,
    "orgId": 53729,
    "resolved": false
  }
}

Door Open

FieldValue
alertConditionIdSensorDoorOpen
alertConditionDescriptionDoor is open
sensorSensor object with id and name
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "SensorDoorOpen",
    "alertConditionDescription": "Door is open",
    "sensor": { "id": 22222, "name": "Trailer Door" },
    "orgId": 53729,
    "resolved": false
  }
}

Route Stop Arrival

FieldValue
alertConditionIdRouteStopArrival
alertConditionDescriptionVehicle arrived at route stop
deviceVehicle device object
routeRoute object with id and name
routeStopStop object with id, name, actualArrivalTimeMs
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "RouteStopArrival",
    "alertConditionDescription": "Vehicle arrived at route stop",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "route": { "id": 6009862266, "name": "Sample Route" },
    "routeStop": { "id": 6066522713, "name": "Buffalo Grove, IL, USA", "actualArrivalTimeMs": 1724869716400 },
    "orgId": 53729,
    "resolved": false
  }
}

Reefer Alarm

FieldValue
alertConditionIdReeferAlarm
alertConditionDescriptionReefer triggered an alarm
deviceVehicle / trailer device object
reeferAlarmCodeManufacturer-specific alarm code
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "ReeferAlarm",
    "alertConditionDescription": "Reefer triggered an alarm",
    "device": { "id": 281474977075805, "name": "Trailer 1" },
    "reeferAlarmCode": "A123",
    "orgId": 53729,
    "resolved": false
  }
}

Reefer Temperature

FieldValue
alertConditionIdReeferTemperatureOutOfRange
deviceReefer trailer device object
temperatureMilliCReefer temperature
setpointMilliCReefer setpoint
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "ReeferTemperatureOutOfRange",
    "alertConditionDescription": "Reefer temperature out of range",
    "device": { "id": 281474977075805, "name": "Trailer 1" },
    "temperatureMilliC": 5000,
    "setpointMilliC": 1000,
    "orgId": 53729,
    "resolved": false
  }
}

Scheduled Maintenance

FieldValue
alertConditionIdMaintenanceScheduledDue
alertConditionDescriptionVehicle has a scheduled maintenance due
deviceVehicle device object
maintenanceObject with name and dueAtMs
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "MaintenanceScheduledDue",
    "alertConditionDescription": "Vehicle has a scheduled maintenance due",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "maintenance": { "name": "Oil Change", "dueAtMs": 1700000000000 },
    "orgId": 53729,
    "resolved": false
  }
}

Unsafe DVIR

FieldValue
alertConditionIdUnsafeDVIR
alertConditionDescriptionDriver submitted an unsafe DVIR
deviceVehicle device object
driverDriver object
dvirDVIR object including id, submittedAtMs, and defects array
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "UnsafeDVIR",
    "alertConditionDescription": "Driver submitted an unsafe DVIR",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "driver": { "id": 12345, "name": "Sample Driver" },
    "dvir": {
      "id": 624372548,
      "submittedAtMs": 1724871169000,
      "defects": [{ "category": "Brakes", "comment": "Brake pads worn" }]
    },
    "orgId": 53729,
    "resolved": false
  }
}

Safe DVIR with Defects

FieldValue
alertConditionIdSafeDVIRWithDefects
alertConditionDescriptionDriver submitted a safe DVIR with defects
deviceVehicle device object
driverDriver object
dvirDVIR object including id, submittedAtMs, and defects array
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "SafeDVIRWithDefects",
    "alertConditionDescription": "Driver submitted a safe DVIR with defects",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "driver": { "id": 12345, "name": "Sample Driver" },
    "dvir": {
      "id": 624372548,
      "submittedAtMs": 1724871169000,
      "defects": [{ "category": "Lights", "comment": "Marker light dim" }]
    },
    "orgId": 53729,
    "resolved": false
  }
}

Panic Button Pressed

FieldValue
alertConditionIdPanicButtonPressed
alertConditionDescriptionPanic button was pressed
deviceVehicle device object
latitude / longitudeCoordinates at time of press
{
  "eventType": "Alert",
  "event": {
    "alertConditionId": "PanicButtonPressed",
    "alertConditionDescription": "Panic button was pressed",
    "device": { "id": 281474977075805, "name": "Little Red" },
    "latitude": 37.7749,
    "longitude": -122.4194,
    "orgId": 53729,
    "resolved": false
  }
}