Kafka events
Kafka message payloads for event based data
Core resource events
Event based kafka messages are produced when core resources change.
Address
Address Created
{
"eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
"eventTime": "1970-01-20T06:39:05.683Z",
"eventType": "AddressCreated",
"orgId": 20936,
"webhookId": "1411751028848270",
"data": {
"address": {
"addressTypes": [
"yard"
],
"contacts": [
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
},
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
},
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
}
],
"createdAtTime": "2021-08-30T19:36:05+00:00",
"externalIds": {
"siteId": "54"
},
"formattedAddress": "298 Burnley St",
"geofence": {
"circle": {
"latitude": 37.7749,
"longitude": 137.7749,
"radiusMeters": 23
},
"polygon": {
"vertices": [
{
"latitude": 37.7749,
"longitude": 137.7749
},
{
"latitude": 37.7749,
"longitude": 137.7749
}
]
},
"settings": {
"showAddresses": [
{
"latitude": 37.7749,
"longitude": 137.7749
},
{
"latitude": 37.7749,
"longitude": 137.7749
},
{
"latitude": 37.7749,
"longitude": 137.7749
},
{
"latitude": 37.7749,
"longitude": 137.7749
}
]
}
},
"id": "494123",
"latitude": 37.7749,
"longitude": 122.4194,
"name": "Company Office #1",
"notes": "This address is located at site 892.",
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
},
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
}
}
}
Address Deleted
{
"eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
"eventTime": "1970-01-20T06:39:05.683Z",
"eventType": "AddressDeleted",
"orgId": 20936,
"webhookId": "1411751028848270",
"data": {
"address": {
"externalIds": {
"siteId": "54"
},
"id": "494123",
"name": "Company Office #1"
}
}
}
Address Updated
{
"eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
"eventTime": "1970-01-20T06:39:05.683Z",
"eventType": "AddressUpdated",
"orgId": 20936,
"webhookId": "1411751028848270",
"data": {
"address": {
"addressTypes": [
"yard"
],
"contacts": [
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
},
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
},
{
"firstName": "Michael",
"id": "312312",
"lastName": "Johnson"
}
],
"createdAtTime": "2021-08-30T19:36:05+00:00",
"externalIds": {
"siteId": "54"
},
"formattedAddress": "298 Burnley St",
"geofence": {
"circle": {
"latitude": 37.7749,
"longitude": 137.7749,
"radiusMeters": 23
},
"polygon": {
"vertices": [
{
"latitude": 37.7749,
"longitude": 137.7749
},
{
"latitude": 37.7749,
"longitude": 137.7749
}
]
},
"settings": {
"showAddresses": [
{
"latitude": 37.7749,
"longitude": 137.7749
},
{
"latitude": 37.7749,
"longitude": 137.7749
},
{
"latitude": 37.7749,
"longitude": 137.7749
},
{
"latitude": 37.7749,
"longitude": 137.7749
}
]
}
},
"id": "494123",
"latitude": 37.7749,
"longitude": 122.4194,
"name": "Company Office #1",
"notes": "This address is located at site 892.",
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
},
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
}
}
}
Driver
Driver Document Submitted
{
"document": {
"createdAtTime": "2024-08-28T19:29:45.000Z",
"documentType": {
"id": "2c541bb5-d033-4a8e-9d53-f3db85d366ff",
"name": "Bill of Lading"
},
"driver": {
"id": "51732619",
"name": "test driver"
},
"fields": [
{
"label": "Photos",
"type": "photo",
"value": {}
},
{
"label": "Reference #",
"type": "string",
"value": {}
}
],
"id": "51732619_1724873385298",
"state": "submitted",
"updatedAtTime": "2024-08-28T19:29:45.000Z",
"vehicle": {
"externalIds": {
"samsara.serial": "G7E5GM59H7"
},
"id": "281474991565165",
"name": "Test G7E5-GM5-9H7"
}
},
"eventType": "documentSubmitted"
}
Driver Created
{
"driver": {
"carrierSettings": {},
"createdAtTime": "2024-08-28T18:56:08.388Z",
"driverActivationStatus": "active",
"eldAdverseWeatherExemptionEnabled": false,
"eldBigDayExemptionEnabled": false,
"eldExempt": false,
"eldPcEnabled": false,
"eldYmEnabled": false,
"id": "51899168",
"name": "test streaming driver",
"timezone": "America/Los_Angeles",
"updatedAtTime": "2024-08-28T18:56:08.388Z",
"username": "teststreamingdriver"
},
"eventType": "driverCreated"
}
Driver Updated
{
"driver": {
"carrierSettings": {},
"createdAtTime": "2024-08-28T18:56:08.388Z",
"driverActivationStatus": "active",
"eldAdverseWeatherExemptionEnabled": false,
"eldBigDayExemptionEnabled": false,
"eldExempt": false,
"eldPcEnabled": false,
"eldYmEnabled": false,
"id": "51899168",
"name": "test streaming driver updated",
"timezone": "America/Los_Angeles",
"updatedAtTime": "2024-08-28T18:56:57.609Z",
"username": "teststreamingdriver"
},
"eventType": "driverUpdated"
}
Forms
Form Submitted
{
"eventType": "formSubmitted",
"form": {
"createdAtTime": "2024-08-28T18:54:20Z",
"fields": [
{
"id": "7dfc8ba4-47ca-48ff-8793-f4b41de8096b",
"label": "submit forms?",
"multipleChoiceValue": {
"value": "Yes"
},
"note": "Test",
"type": "multiple_choice"
}
],
"formTemplate": {
"id": "b3a18c2f-1a6b-402c-96c1-bdb764611c40",
"revisionId": "39140122-2f3a-49a5-b5cb-d5cb7e6a1423"
},
"id": "f1e68f82-76f5-4303-869c-45a37c8e6f4d",
"location": {
"latitude": 42.11847729042255,
"longitude": -87.93395625558578
},
"status": "",
"submittedAtTime": "2024-08-28T18:54:20Z",
"submittedBy": {
"id": "51732619",
"type": "driver"
},
"updatedAtTime": "2024-08-28T18:54:20Z"
}
}
Maintenance
DVIR Submitted
{
"dvir": {
"authorSignature": {
"signatoryUser": {
"id": "51732619",
"name": "test driver"
},
"signedAtTime": "2024-08-28T18:52:49.000Z",
"type": "driver"
},
"driver": {
"id": "51732619",
"name": "test driver"
},
"endTime": "2024-08-28T18:52:49.000Z",
"formattedLocation": "Vancouver – Blaine Highway, Surrey, BC, V3S 9N7",
"hasDefects": false,
"id": "624372548",
"needsCorrection": false,
"safetyStatus": "safe",
"startTime": "2024-08-28T18:52:42.086Z",
"type": "postTrip",
"vehicle": {
"externalIds": {
"samsara.serial": "G7E5GM59H7"
},
"gateway": {
"serial": "G7E5GM59H7"
},
"id": "281474991565165",
"licensePlate": "09999",
"name": "Test G7E5-GM5-9H7"
}
},
"eventType": "dvirSubmitted"
}
Engine Fault On
Contact your Samsara account representative to enable this event for your organization.
{
"eventType": "engineFaultOn",
"fault": {
"j1939": {
"fmi": {
"description": "Low—most severe",
"id": "1"
},
"occurrenceCount": 50,
"spn": {
"description": "Aux Valve 0 Retract Port Measured Flow",
"id": "1900"
},
"txId": "21"
}
},
"vehicle": {
"externalIds": {
"samsara.serial": "GYWYJ42G8E",
"samsara.vin": "3ALACWFC5NDNB5090"
},
"id": "281474991840886",
"name": "GYWY-J42-G8E"
}
}
Engine Fault Off
Contact your Samsara account representative to enable this event for your organization.
{
"eventType": "engineFaultOff",
"fault": {
"j1939": {
"lamps": {
"emissions": true
}
}
},
"vehicle": {
"externalIds": {
"samsara.serial": "GYWYJ42G8E",
"samsara.vin": "3ALACWFC5NDNB5090"
},
"id": "281474991840886",
"name": "GYWY-J42-G8E"
}
}
Location & Movement
Geofence Entry
{
"address": {
"formattedAddress": "I-5, Blaine, WA, USA",
"geofence": {
"circle": {
"latitude": 48.99867107485855,
"longitude": -122.75289223295576,
"radiusMeters": 322
}
},
"id": "170886751",
"name": "test Geofence"
},
"eventType": "geofenceEntry",
"vehicle": {
"assetType": "vehicle",
"externalIds": {
"samsara.serial": "G7E5GM59H7"
},
"id": "281474991565165",
"licensePlate": "09999",
"name": "Test G7E5-GM5-9H7"
}
}
Geofence Exit
{
"address": {
"formattedAddress": "I-5, Blaine, WA, USA",
"geofence": {
"circle": {
"latitude": 48.99867107485855,
"longitude": -122.75289223295576,
"radiusMeters": 322
}
},
"id": "170886751",
"name": "test Geofence"
},
"eventType": "geofenceExit",
"vehicle": {
"assetType": "vehicle",
"externalIds": {
"samsara.serial": "G7E5GM59H7"
},
"id": "281474991565165",
"licensePlate": "09999",
"name": "Test G7E5-GM5-9H7"
}
}
Routing
Route Stop Arrival
{
"driver": {
"id": "51732619",
"name": "test driver"
},
"eventType": "routeStopArrival",
"operation": "stop departed",
"route": {
"actualRouteEndTime": "2024-08-28T18:48:36.400Z",
"actualRouteStartTime": "2024-08-28T18:47:02.593Z",
"id": "6009862266",
"name": "test route",
"scheduledRouteEndTime": "2024-08-28T18:55:00.000Z",
"scheduledRouteStartTime": "2024-08-28T18:47:00.000Z",
"settings": {
"routeCompletionCondition": "arriveLastStop",
"routeStartingCondition": "departFirstStop"
},
"stops": [
{
"actualArrivalTime": "2024-08-28T18:47:02.593Z",
"actualDepartureTime": "2024-08-28T18:47:02.593Z",
"id": "6066522712",
"liveSharingUrl": "https://cloud.samsara.com/o/5005929/fleet/viewer/job/vG0yIZb6eySjP4MMoa2S",
"name": "Wheeling, IL, USA",
"notes": "",
"scheduledDepartureTime": "2024-08-28T18:47:00.000Z",
"singleUseLocation": {
"address": "Wheeling, IL, USA",
"latitude": 42.1391927,
"longitude": -87.9289591
},
"state": "departed"
},
{
"actualArrivalTime": "2024-08-28T18:48:36.400Z",
"actualDepartureTime": "2024-08-28T18:48:36.400Z",
"enRouteTime": "2024-08-28T18:47:02.593Z",
"id": "6066522713",
"liveSharingUrl": "https://cloud.samsara.com/o/5005929/fleet/viewer/job/ymbM5oebsE3Ng0hHDG66",
"name": "Buffalo Grove, IL, USA",
"notes": "test notes",
"scheduledArrivalTime": "2024-08-28T18:55:00.000Z",
"singleUseLocation": {
"address": "Buffalo Grove, IL, USA",
"latitude": 42.1662831,
"longitude": -87.9631308
},
"state": "departed"
}
]
},
"routeStopDetails": {
"actualArrivalTime": "2024-08-28T18:48:36.400Z",
"actualDepartureTime": "2024-08-28T18:48:36.400Z",
"enRouteTime": "2024-08-28T18:47:02.593Z",
"id": "6066522713",
"liveSharingUrl": "https://cloud.samsara.com/o/5005929/fleet/viewer/job/ymbM5oebsE3Ng0hHDG66",
"state": "departed"
},
"time": "2024-08-28T18:48:36.400Z",
"type": "route tracking"
}
Route Stop Departure
{
"driver": {
"id": "51732619",
"name": "test driver"
},
"eventType": "routeStopDeparture",
"operation": "stop departed",
"route": {
"actualRouteStartTime": "2024-08-28T18:47:02.593Z",
"id": "6009862266",
"name": "test route",
"scheduledRouteEndTime": "2024-08-28T18:55:00.000Z",
"scheduledRouteStartTime": "2024-08-28T18:47:00.000Z",
"settings": {
"routeCompletionCondition": "arriveLastStop",
"routeStartingCondition": "departFirstStop"
},
"stops": [
{
"actualArrivalTime": "2024-08-28T18:47:02.593Z",
"actualDepartureTime": "2024-08-28T18:47:02.593Z",
"id": "6066522712",
"liveSharingUrl": "https://cloud.samsara.com/o/5005929/fleet/viewer/job/vG0yIZb6eySjP4MMoa2S",
"name": "Wheeling, IL, USA",
"notes": "",
"scheduledDepartureTime": "2024-08-28T18:47:00.000Z",
"singleUseLocation": {
"address": "Wheeling, IL, USA",
"latitude": 42.1391927,
"longitude": -87.9289591
},
"state": "departed"
},
{
"enRouteTime": "2024-08-28T18:47:02.593Z",
"eta": "2024-08-30T01:56:09.786Z",
"id": "6066522713",
"liveSharingUrl": "https://cloud.samsara.com/o/5005929/fleet/viewer/job/ymbM5oebsE3Ng0hHDG66",
"name": "Buffalo Grove, IL, USA",
"notes": "test notes",
"scheduledArrivalTime": "2024-08-28T18:55:00.000Z",
"singleUseLocation": {
"address": "Buffalo Grove, IL, USA",
"latitude": 42.1662831,
"longitude": -87.9631308
},
"state": "en route"
}
]
},
"routeStopDetails": {
"actualArrivalTime": "2024-08-28T18:47:02.593Z",
"actualDepartureTime": "2024-08-28T18:47:02.593Z",
"id": "6066522712",
"liveSharingUrl": "https://cloud.samsara.com/o/5005929/fleet/viewer/job/vG0yIZb6eySjP4MMoa2S",
"state": "departed"
},
"time": "2024-08-28T18:47:02.593Z",
"type": "route tracking"
}
Safety
Severe Speeding Started
{
"data": {
"startTime": "2024-08-23T17:25:53.101Z",
"tripStartTime": "2024-08-23T17:25:53.101Z",
"vehicle": {
"id": "281474991565165"
}
},
"eventType": "severeSpeedingStarted"
}
Severe Speeding Ended
{
"data": {
"endTime": "2024-08-28T18:37:52.834Z",
"startTime": "2024-08-28T18:36:07.713Z",
"tripStartTime": "2024-08-28T18:35:52.027Z",
"vehicle": {
"id": "281474991565165"
}
},
"eventType": "severeSpeedingEnded"
}
Vehicle
Vehicle Created
{
"eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
"eventTime": "1970-01-20T06:39:05.683Z",
"eventType": "VehicleCreated",
"orgId": 20936,
"webhookId": "1411751028848270",
"data": {
"vehicle": {
"assetType": "vehicle",
"externalIds": {
"maintenanceId": "250020"
},
"gateway": {
"serial": "GFRV-43N-VGX"
},
"id": "494123",
"licensePlate": "6SAM123",
"name": "Fleet Truck #1",
"vehicleVin": "1GBJ6P1B2HV112765"
}
}
}
Vehicle Updated
{
"eventType": "vehicleUpdated",
"vehicle": {
"createdAtTime": "",
"externalIds": {
"samsara.serial": "G7E5GM59H7"
},
"gateway": {
"model": "VG54NA",
"serial": "G7E5-GM5-9H7"
},
"harshAccelerationSettingType": "automatic",
"id": "281474991565165",
"licensePlate": "09999",
"model": "VG54NA",
"name": "Test G7E5-GM5-9H7",
"serial": "G7E5-GM5-9H7",
"staticAssignedDriver": {
"id": "51732619",
"name": "test driver"
},
"vehicleRegulationMode": "regulated"
}
}
Driver Compliance
This event type is not available by default and requires approval. Reach out to Samsara to request access.
HOS Clocks
{
"clocks": {
"break": {
"timeUntilBreakDurationMs": 28800000
},
"cycle": {
"cycleRemainingDurationMs": 252000000,
"cycleStartedAtTime": "2020-01-27T07:06:25Z",
"cycleTomorrowDurationMs": 252000000
},
"drive": {
"driveRemainingDurationMs": 39600000
},
"shift": {
"shiftRemainingDurationMs": 50400000
}
},
"currentDutyStatus": {
"hosStatusType": "offDuty"
},
"currentVehicle": {
"ExternalIds": {
"maintenanceId": "250020",
"payrollId": "ABFS18600"
},
"id": "123456789",
"name": "Midwest Truck #4"
},
"driver": {
"id": "88668",
"name": "Susan Bob"
},
"timestamp": "2025-02-07T17:42:01.740Z",
"violations": {
"cycleViolationDurationMs": 39600000,
"shiftDrivingViolationDurationMs": 39600000
}
}
}
- Timestamp: exact time (in UTC - reference) when the HOS clocks snapshot was taken for this driver
Updated 4 days ago
What’s Next