Samsara Incidents API
The Incidents API from Samsara — 1 operation(s) for incidents.
Samsara Incidents API is one of 90 APIs that Samsara publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Incidents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.
This API exposes 1 operation across 1 path, and defines 143 schemas. It is described by OpenAPI 3.2.0, at version 2024-11-18.
Requests are made against 2 base URLs: https://api.samsara.com/, https://api.eu.samsara.com/.
1 operations
1 paths
143 schemas
1 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Samsara Incidents API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessTokenHeader).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Incidents 1
GET
/alerts/incidents/stream
Get Alert Incidents
Schemas 143
The contract defines 143 schemas that model the data the API accepts and returns. The most detailed are WorkflowIncidentDetailsObjectResponseBody (54 properties), RoutesStopResponseObjectResponseBody (19 properties), FormSubmissionResponseObjectResponseBody (17 properties), FormsFieldInputObjectResponseBody (16 properties). Each schema is shown below with its type and property counts.
FormsNumberValueObjectResponseBody
object
The value of a number form input field.
1 property
1 required
DvirResolvedByObjectResponseBody
object
The person who resolved this defect.
3 properties
3 required
alertObjectVehicleResponseBody
object
The vehicle associated with the alert.
7 properties
2 required
AlertsGetIncidentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
alertObjectMachineInputResponseBody
object
A machine input associated with the alert
2 properties
1 required
DataInputValueResponseBody
object
Details specific to Data Input Value.
1 property
WorkflowDvirObjectResponseBody
object
A DVIR description
14 properties
7 required
signatureValueObjectResponseBody
object
The value of a signature field. Only present for signature fields.
4 properties
FormSubmittedResponseBody
object
Details specific to Form Submitted.
1 property
1 required
FormSubmissionResponseObjectResponseBody
object
Form Submission response object.
17 properties
8 required
documentResponseObjectResponseBody
object
A single document.
13 properties
6 required
FormsMultipleChoiceValueObjectResponseBody
object
The value of a multiple choice form input field.
1 property
1 required
FormsPolymorphicUserObjectResponseBody
object
User or driver object.
2 properties
2 required
DriverDocumentSubmittedResponseBody
object
Details specific to Driver Document Submitted.
1 property
JammingDetectedResponseBody
object
Details specific to Jamming Detected.
3 properties
EngineIdleDataResponseBody
object
Details specific to Engine Idle.
2 properties
WorkflowIncidentDetailsObjectResponseBody
object
Object representing the granular details of the condition. These details will vary depending on the condition.
54 properties
OutOfRouteResponseBody
object
Details specific to Out Of Route.
3 properties
DashcamDisconnectedResponseBody
object
Details specific to Dashcam Disconnected.
3 properties
FormsLocationObjectResponseBody
object
Form template location object.
2 properties
2 required
alertObjectOnvifCameraStreamResponseBody
object
A camera stream associated with the alert.
4 properties
1 required
AlertsGetIncidentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
RouteStopETAResponseBody
object
Details specific to Route Stop ETA.
3 properties
AlertsGetIncidentsResponseBody
object
2 properties
2 required
barcodeValueObjectResponseBody
object
2 properties
DriverRecordedResponseBody
object
Details specific to Driver Recorded.
2 properties
PersonDetectedResponseBody
object
Details specific to Person Detected.
1 property
CellSignalLossResponseBody
object
Details specific to Cell Signal Loss.
3 properties
VehicleFaultsResponseBody
object
Details specific to Vehicle Faults.
3 properties
WorkflowGeofenceEventResponseObjectResponseBody
object
2 properties
FuelLevelPercentageResponseBody
object
Details specific to Fuel Level Percentage.
3 properties
scannedDocumentValueObjectResponseBody
object
2 properties
PanicButtonResponseBody
object
Details specific to Panic Button.
3 properties
FormsAssetObjectResponseBody
object
Tracked or untracked (i.e. manually entered) asset object.
3 properties
1 required
DeviceMovementStoppedDataResponseBody
object
Details specific to Device Movement Stopped.
3 properties
fieldObjectValueResponseBody
object
The value of the document field. The shape of value depends on the type.
8 properties
RoutesSingleUseAddressObjectResponseBody
object
This field is used to indicate stops along the route for which an address has not been persisted. This field is mutually exclusive with addressId.
3 properties
2 required
FormsSignatureValueObjectResponseBody
object
The value of a signature form input field.
1 property
1 required
TireFaultsResponseBody
object
Details specific to Tire Faults.
3 properties
FormsTableColumnObjectResponseBody
object
Defines a column in a table form input field.
3 properties
3 required
WorkflowAddressEventWithGeofenceObjectResponseBody
object
A minimal Address object representation used in AddressEventObject objects
5 properties
3 required
DriverAppSignInResponseBody
object
Details specific to Driver App Sign In.
1 property
AlertsGetIncidentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
WorkflowGeofenceResponseBody
object
The geofence that defines this address and its bounds. This can either be a circle or a polygon, but not both.
3 properties
CameraConnectorDisconectedResponseBody
object
Details specific to Camera Connector Disconnected.
3 properties
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
CameraStreamIssueResponseBody
object
Details specific to Camera Stream Issue.
1 property
MotionDetectedResponseBody
object
Details specific to Motion Detected.
1 property
LiveSharingLinkResponseObjectResponseBody
object
Live Sharing Link response object.
3 properties
2 required
GoaAddressTinyResponseResponseBody
object
A minified Address object
3 properties
2 required
VehicleDefLevelPercentageResponseBody
object
Details specific to Vehicle DEF Level Percentage.
3 properties
AlertsGetIncidentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
FormsCheckBoxesValueObjectResponseBody
object
The value of a check boxes form input field.
1 property
1 required
GpsSignalLossResponseBody
object
Details specific to GPS Signal Loss.
3 properties
RouteStopDetailsObjectResponseBody
object
7 properties
4 required
FormsTextValueObjectResponseBody
object
The value of a text form input field.
1 property
1 required
FormsTableRowObjectResponseBody
object
Defines a row in a table form input field.
2 properties
2 required
IssueSourceObjectResponseBody
object
Contains information about where an issue came from.
2 properties
1 required
SevereSpeedingStartedResponseObjectResponseBody
object
The start of a severe speeding event
1 property
1 required
MinimalRouteStopResponseBody
object
A single route stop for a route.
9 properties
2 required
GoaAttributeTinyResponseBody
object
Attribute properties.
4 properties
ScheduledMaintenanceOdometerDataResponseBody
object
Details specific to Scheduled Maintenance By Odometer.
3 properties
IssueCreatedResponseBody
object
Details specific to Issue Created.
1 property
1 required
DriverAppSignOutResponseBody
object
Details specific to Driver App Sign Out.
1 property
GetWorkflowIncidentResponseObjectResponseBody
object
7 properties
6 required
SiteGatewayDisconnectedResponseBody
object
Details specific to Site Gateway Disconnected.
3 properties
DvirDefectsObject_v2022_09_13ResponseBody
object
A description of a DVIR defect
11 properties
4 required
AmbientTemperatureResponseBody
object
Details specific to Ambient Temperature.
1 property
WorkflowIncidentConditionObjectResponseBody
object
Object representing the granular details of the condition. These details will vary depending on the condition.
3 properties
3 required
GoaRouteStopTinyResponseResponseBody
object
A minified route stop object
3 properties
GoaRouteTinyResponseResponseBody
object
A minified representation of a single route.
3 properties
1 required
HarshEventDataResponseBody
object
Details specific to Harsh Event.
2 properties
WorkflowPolygonResponseBody
object
Information about a polygon geofence. This field is only needed if the geofence is a polygon.
1 property
WebhookRouteResponseObjectResponseBody
object
10 properties
1 required
GoaDocumentTypeTinyResponseResponseBody
object
A minified document type object
2 properties
OutsideGeofenceDataResponseBody
object
Details specific to Outside Geofence.
3 properties
VertexResponseBody
object
The vertex of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.
2 properties
2 required
IssueResponseObjectResponseBody
object
Issue response object.
15 properties
8 required
FormsTableCellObjectResponseBody
object
Defines a cell in a table row.
10 properties
2 required
UnassignedDrivingDataResponseBody
object
Details specific to Unassigned Driving.
2 properties
FormsMediaRecordObjectResponseBody
object
Forms media record object.
4 properties
2 required
DeviceMovementDataResponseBody
object
Details specific to Device Movement.
3 properties
RoutesStopResponseObjectResponseBody
object
19 properties
3 required
AlertsGetIncidentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
GoaTagTinyResponseResponseBody
object
A minified tag object
3 properties
2 required
GoaVehicleTinyResponseResponseBody
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
3 properties
SettingsResponseBody
object
Information about a geofence settings.
1 property
FormsDateTimeValueObjectResponseBody
object
The value of a datetime form input field.
2 properties
2 required
EngineOnResponseBody
object
Details specific to Engine On.
3 properties
dateTimeValueObjectResponseBody
object
The value of a date time field. Only present for date time fields.
1 property
alertObjectSensorResponseBody
object
A sensor associated with the alert.
5 properties
1 required
AlertsGetIncidentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
FormsScoreObjectResponseBody
object
Forms score object.
3 properties
3 required
SevereSpeedingStartedObjectResponseBody
object
The start of a severe speeding event
3 properties
2 required
ScheduledMaintenanceByEngineHoursResponseBody
object
Details specific to Scheduled Maintenance By Engine Hours.
3 properties
AlertsGetIncidentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
FormsPersonObjectResponseBody
object
Tracked or untracked (i.e. manually entered) person object.
3 properties
1 required
ScheduledMaintenanceDataResponseBody
object
Details specific to Scheduled Maintenance.
3 properties
GatewayDisconnectedResponseBody
object
Details specific to Gateway Disconnected.
3 properties
multipleChoiceValueObjectResponseBody
object
2 properties
WorkflowDvirSubmittedResponseObjectResponseBody
object
Details specific to DVIR Submitted.
3 properties
DriverMessageSentResponseBody
object
Details specific to Driver Message Sent.
1 property
InsideGeofenceDataResponseBody
object
Details specific to Inside Geofence.
3 properties
HosViolationDataResponseBody
object
Details specific to Hos Violation.
1 property
InactivityResponseBody
object
Details specific to Inactivity.
1 property
DriverObjectResponseBody
object
Current driver of the vehicle. Note: this parameter includes all assignment sources, not just static assignments.
2 properties
fieldObjectResponseBody
object
3 properties
3 required
VehicleResponseResponseBody
object
A vehicle object
6 properties
TamperingDetectedResponseBody
object
Details specific to Tampering Detected.
3 properties
CloudBackupUploadIssueResponseBody
object
Details specific to Cloud Backup Upload Issue.
3 properties
VehicleBatteryVoltageResponseBody
object
Details specific to Vehicle Battery Voltage.
3 properties
alertObjectProductResponseBody
object
The product associated with the alert
1 property
conditionalFieldSectionObjectResponseBody
object
4 properties
GoaTrailerTinyResponseResponseBody
object
A minified trailer object
3 properties
photoValueObjectResponseBody
object
2 properties
alertObjectTrailerResponseBody
object
A trailer associated with the alert
6 properties
1 required
DriverMessageReceivedResponseBody
object
Details specific to Driver Message Received.
1 property
GoaGatewayTinyResponseResponseBody
object
A minified gateway object
2 properties
2 required
VehicleWithGatewayTinyResponseResponseBody
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
7 properties
FormsPersonValueObjectResponseBody
object
The value of a person form input field.
1 property
1 required
FormsIssueCreatedByFieldObjectResponseBody
object
Issue created from this form input field input object.
2 properties
1 required
RouteSettingsResponseBody
object
An optional dictionary, only necessary to override the defaults for route start and end conditions.
2 properties
AlertsGetIncidentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
EngineOffResponseBody
object
Details specific to Engine Off.
3 properties
AlertsGetIncidentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
VehicleDetectedResponseBody
object
Details specific to Vehicle Detected.
1 property
ReeferTemperatureResponseBody
object
Details specific to Reefer Temperature.
3 properties
FormsAssetValueObjectResponseBody
object
The value of an asset form input field.
1 property
1 required
WorkflowAuthorSignatureObjectResponseBody
object
An author signature for DVIRs with a signed time.
3 properties
3 required
GoaDocumentTinyResponseResponseBody
object
A minified Document object
2 properties
1 required
FormsTableValueObjectResponseBody
object
The value of a table form input field.
2 properties
2 required
SpeedDataResponseBody
object
Details specific to Speed.
7 properties
4 required
FormsMediaValueObjectResponseBody
object
The value of a media form input field.
1 property
1 required
WorkflowSignatoryUserObjectResponseBody
object
The user who signed the DVIR.
2 properties
2 required
WorkflowCircleResponseBody
object
Information about a circular geofence. This field is only needed if the geofence is a circle.
3 properties
1 required
FormTemplateReferenceObjectResponseBody
object
Form template reference object.
2 properties
2 required
alertObjectSitesResponseBody
object
A site associated with the alert.
3 properties
1 required
alertObjectWorkforceCameraDeviceResponseBody
object
A camera device associated with the alert
4 properties
1 required
FormsFieldInputObjectResponseBody
object
Forms input field object.
16 properties
2 required
alertObjectDriverResponseBody
object
A driver associated with the alert
5 properties
1 required
GatewayWithVehicleTinyResponseResponseBody
object
3 properties
2 required
GoaDriverTinyResponseResponseBody
object
A minified driver object. This object is only returned if the route is assigned to the driver.
3 properties
1 required
AlertsGetIncidentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Samsara 12
Other APIs Samsara publishes across the network.
Samsara Activity API
Samsara Addresses API
Samsara Aemp API
Samsara Applications API
Samsara Assets API
Samsara Assignments API
Samsara Attributes API
Samsara Audit API
Samsara Beta A P Is API
Samsara Camera API
Samsara Cameras API
Samsara Cargo API
#Incidents
Where this information came from
This is an independent, third-party profile of Samsara Incidents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.