AlertIncident Event Schema

Webhook payload schema for the AlertIncident event triggered when a configured alert fires for a fleet condition.

Alert incidents can trigger an alert 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. The example below shows a representative payload. See the Alert Webhook Event Schema for supported Alert Webhook 2.0 payloads.

Example

{
  "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
  "eventTime": "1970-01-20T06:39:05.683Z",
  "eventType": "AlertIncident",
  "orgId": 20936,
  "webhookId": "1411751028848270",
  "data": {
    "conditions": [
      {
        "description": "Vehicle speed exceeds threshold",
        "details": {
          "severeSpeeding": {
            "driver": {
              "id": "45646",
              "name": "Driver Bob"
            },
            "vehicle": {
              "id": "494123",
              "name": "Fleet Truck #1"
            },
            "speedMilesPerHour": 75,
            "speedLimitMilesPerHour": 55
          }
        },
        "triggerId": 1000
      }
    ],
    "configurationId": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
    "happenedAtTime": "2019-06-13T19:08:25Z",
    "incidentUrl": "https://cloud.samsara.com/o/1/fleet/workflows/123",
    "isResolved": false,
    "updatedAtTime": "2019-06-13T19:08:25Z"
  }
}

Reference

Alert incident payloads include a common envelope and a data.conditions[].details object whose shape depends on the alert condition type. See the Alert Webhook Event Schema for the complete condition-specific reference.

Property Name	Description
conditions object array	Conditions associated with the incident. Each condition includes a human-readable description, a triggerId, and condition-specific details.
conditions[].details object	Granular alert details. The nested object varies by alert type, such as severe speeding, camera stream issue, ambient temperature, geofence, document submitted, route stop arrival, or vehicle fault conditions.
configurationId string	ID of the alert configuration that generated the incident.
happenedAtTime string	Time when the incident occurred, formatted as an RFC 3339 timestamp.
incidentUrl string	URL to view the incident in the Samsara dashboard.
isResolved boolean	Whether the incident has been resolved.
updatedAtTime string	Time when the incident was last updated, formatted as an RFC 3339 timestamp.