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"
},
"durationMs": 2365,
"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"
}
}Ridership
Ridership kafka messages are produced when ridership actions occur on a route, such as passenger boarding, drop-off, absence marking, undo operations, and unrecognized RFID scans.
Passenger Onboard
Produced when one or more passengers board a vehicle on a ridership route.
Example
{
"eventType": "passengerOnboard",
"eventId": "0193f8a4-7e1c-7000-8000-000000000001",
"occurredAt": "2026-04-15T14:30:00Z",
"createdAt": "2026-04-15T14:30:02Z",
"route": {
"id": "98765",
"externalIds": {
"customer.runTemplateId": "28042464"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
},
"actualStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"location": {
"latitude": 37.7749123,
"longitude": -122.4194155
},
"boardingMethod": "rfid",
"passengerEvents": [
{
"eventId": "0193f8a4-7e1c-7000-8000-000000000001",
"plannedStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"passenger": {
"type": "known",
"id": "0193f8a4-0000-7000-8000-000000000100",
"identifier": {
"type": "rfid",
"value": "E00401007B3E1726"
},
"externalIds": {
"customer.studentId": "STU-2046"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
}
}
],
"isBulk": false
}Reference
| Property Name | Type | Description |
|---|---|---|
| eventType | string | Always "passengerOnboard". |
| eventId | string | Unique identifier for this event. For a bulk action, this is the ID of the entire action. Each passenger event has its own ID in passengerEvents[].eventId. |
| occurredAt | string | RFC 3339 timestamp of when the boarding occurred. |
| createdAt | string | RFC 3339 timestamp of when the event was created in the system. |
| route | object | The ridership route on which this event occurred. |
| id | string | ID of the route. |
| externalIds | object | A map of external IDs associated with the route. Only present if the route has external IDs configured. |
| tags | array | Tags assigned to the route. Always present. Empty array when none. Each entry is {id, name, parentTagId?}. |
| actualStop | object | The stop where the boarding occurred. Only present if the event is associated with a stop. |
| id | string | ID of the stop. |
| externalIds | object | A map of external IDs associated with the stop. Only present if the stop has external IDs configured. |
| location | object | Location where the event occurred. Contains {latitude, longitude}. Omitted when location data is unavailable or does not meet quality requirements. |
| boardingMethod | string | How boarding was recorded. "rfid" means the action was performed using an RFID scan. "manual" means the action was performed manually by the driver. |
| passengerEvents | array | One entry per passenger. Always present. May be empty. |
| eventId | string | Unique ID for this passenger event. For a single passenger it matches the top-level eventId. Bulk passengers have individual IDs. |
| plannedStop | object | Planned boarding stop, when the known passenger has a route assignment. |
| id | string | ID of the planned stop. |
| externalIds | object | A map of external IDs associated with the planned stop. |
| passenger | object | Passenger identity. Its type is known, anonymous, or unregistered. |
| type | string | "known" means the passenger has a profile. "anonymous" means the passenger is recorded without a profile or scanned identifier. "unregistered" means the passenger is identified by a scanned identifier but has no profile. |
| id | string | Passenger profile ID. Present for known passengers. |
| identifier | object | Identifier such as an RFID card. Contains {type, value}. Present for unregistered passengers and known passengers boarding by RFID. |
| type | string | Identifier type. "rfid" means an RFID identifier, such as an RFID card. |
| value | string | The value of the scanned identifier, such as an RFID card tag value. |
| externalIds | object | Customer external IDs for a known passenger profile, when configured. |
| tags | array | Tags on a known passenger profile. May be empty. Each entry is {id, name, parentTagId?}. |
| isBulk | boolean | Whether this was a bulk boarding operation (multiple passengers boarded at once). |
| bulkSource | string | UI flow for a bulk action. "atStop" means the action was initiated at a stop. "expectedToday" means it was initiated from the expected passenger list. "everyoneOnboard" means it applied to everyone onboard. "postChildCheck" means it was initiated from the post-child check flow. Only present when isBulk is true. |
Passenger Drop Off
Produced when one or more passengers are dropped off from a vehicle on a ridership route.
Example
{
"eventType": "passengerDropOff",
"eventId": "0193f8a4-7e1c-7000-8000-000000000001",
"occurredAt": "2026-04-15T15:05:00Z",
"createdAt": "2026-04-15T15:05:01Z",
"route": {
"id": "98765",
"externalIds": {
"customer.runTemplateId": "28042464"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
},
"actualStop": {
"id": "54322",
"externalIds": {
"customer.stopTemplateId": "508166311"
}
},
"location": {
"latitude": 37.7749123,
"longitude": -122.4194155
},
"dropOffMethod": "rfid",
"passengerEvents": [
{
"eventId": "0193f8a4-7e1c-7000-8000-000000000001",
"plannedStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"passenger": {
"type": "known",
"id": "0193f8a4-0000-7000-8000-000000000100",
"identifier": {
"type": "rfid",
"value": "E00401007B3E1726"
},
"externalIds": {
"customer.studentId": "STU-2046"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
}
}
],
"isBulk": false
}Reference
| Property Name | Type | Description |
|---|---|---|
| eventType | string | Always "passengerDropOff". |
| eventId | string | Unique identifier for this event. For a bulk action, this is the ID of the entire action. Each passenger event has its own ID in passengerEvents[].eventId. |
| occurredAt | string | RFC 3339 timestamp of when the drop-off occurred. |
| createdAt | string | RFC 3339 timestamp of when the event was created in the system. |
| route | object | The ridership route on which this event occurred. |
| id | string | ID of the route. |
| externalIds | object | A map of external IDs associated with the route. Only present if the route has external IDs configured. |
| tags | array | Tags assigned to the route. Always present. Empty array when none. Each entry is {id, name, parentTagId?}. |
| actualStop | object | The stop where the drop-off occurred. Only present if the event is associated with a stop. |
| id | string | ID of the stop. |
| externalIds | object | A map of external IDs associated with the stop. Only present if the stop has external IDs configured. |
| location | object | Location where the event occurred. Contains {latitude, longitude}. Omitted when location data is unavailable or does not meet quality requirements. |
| dropOffMethod | string | How drop-off was recorded. "rfid" means the action was performed using an RFID scan. "manual" means the action was performed manually by the driver. |
| passengerEvents | array | One entry per passenger. Always present. May be empty. |
| eventId | string | Unique ID for this passenger event. For a single passenger it matches the top-level eventId. Bulk passengers have individual IDs. |
| plannedStop | object | Planned drop-off stop, when the known passenger has a route assignment. |
| id | string | ID of the planned stop. |
| externalIds | object | A map of external IDs associated with the planned stop. |
| passenger | object | Passenger identity. Its type is known, anonymous, or unregistered. |
| type | string | "known" means the passenger has a profile. "anonymous" means the passenger is recorded without a profile or scanned identifier. "unregistered" means the passenger is identified by a scanned identifier but has no profile. |
| id | string | Passenger profile ID. Present for known passengers. |
| identifier | object | Identifier such as an RFID card. Contains {type, value}. Present for unregistered passengers and known passengers dropped off by RFID. |
| type | string | Identifier type. "rfid" means an RFID identifier, such as an RFID card. |
| value | string | The value of the scanned identifier, such as an RFID card tag value. |
| externalIds | object | Customer external IDs for a known passenger profile, when configured. |
| tags | array | Tags on a known passenger profile. May be empty. Each entry is {id, name, parentTagId?}. |
| isBulk | boolean | Whether this was a bulk drop-off operation. |
| bulkSource | string | UI flow for a bulk action. "atStop" means the action was initiated at a stop. "expectedToday" means it was initiated from the expected passenger list. "everyoneOnboard" means it applied to everyone onboard. "postChildCheck" means it was initiated from the post-child check flow. Only present when isBulk is true. |
Passenger Marked Absent
Produced when one or more known passengers are marked as absent on a ridership route.
Example
{
"eventType": "passengerMarkedAbsent",
"eventId": "0193f8a4-7e1c-7000-8000-000000000005",
"occurredAt": "2026-04-15T14:35:00Z",
"createdAt": "2026-04-15T14:35:01Z",
"route": {
"id": "98765",
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
},
"actualStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"passengerEvents": [
{
"eventId": "0193f8a4-7e1c-7000-8000-000000000005",
"plannedStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"passenger": {
"type": "known",
"id": "0193f8a4-0000-7000-8000-000000000100",
"externalIds": {
"customer.studentId": "STU-2046"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
}
}
],
"isBulk": false
}Reference
| Property Name | Type | Description |
|---|---|---|
| eventType | string | Always "passengerMarkedAbsent". |
| eventId | string | Unique identifier for this event. For a bulk action, this is the ID of the entire action. Each passenger event has its own ID in passengerEvents[].eventId. |
| occurredAt | string | RFC 3339 timestamp of when the absence was recorded. |
| createdAt | string | RFC 3339 timestamp of when the event was created in the system. |
| route | object | The ridership route on which this event occurred. |
| id | string | ID of the route. |
| externalIds | object | A map of external IDs associated with the route. Only present if the route has external IDs configured. |
| tags | array | Tags assigned to the route. Always present. Empty array when none. Each entry is {id, name, parentTagId?}. |
| actualStop | object | The stop associated with the absence. Only present if the event is associated with a stop. |
| id | string | ID of the stop. |
| externalIds | object | A map of external IDs associated with the stop. Only present if the stop has external IDs configured. |
| passengerEvents | array | One entry per passenger marked absent. Always present. |
| eventId | string | Unique ID for this passenger event. |
| plannedStop | object | The passenger's planned stop, when they have a route assignment. |
| id | string | ID of the planned stop. |
| externalIds | object | A map of external IDs associated with the planned stop. |
| passenger | object | Passenger identity, with type and the profile fields for a known passenger. |
| type | string | Always known. Marked-absent events are for passengers with a profile. |
| id | string | Passenger profile ID for a known passenger. |
| externalIds | object | Customer external IDs for the known passenger, when configured. |
| tags | array | Tags assigned to the known passenger. May be empty. |
| isBulk | boolean | Whether this was a bulk absence-marking operation. |
Passenger Onboard Undo
Produced when a previous passenger boarding is undone (reversed).
Example
{
"eventType": "passengerOnboardUndo",
"eventId": "0193f8a4-7e1c-7000-8000-000000000010",
"occurredAt": "2026-04-15T14:32:00Z",
"createdAt": "2026-04-15T14:32:01Z",
"route": {
"id": "98765",
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
},
"actualStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"boardingMethod": "rfid",
"passengerEvents": [
{
"eventId": "0193f8a4-7e1c-7000-8000-000000000010",
"plannedStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"passenger": {
"type": "known",
"id": "0193f8a4-0000-7000-8000-000000000100",
"identifier": {
"type": "rfid",
"value": "E00401007B3E1726"
},
"externalIds": {
"customer.studentId": "STU-2046"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
}
}
],
"isBulk": false
}Reference
| Property Name | Type | Description |
|---|---|---|
| eventType | string | Always "passengerOnboardUndo". |
| eventId | string | Unique identifier for this undo event. For a bulk action, this is the ID of the entire action. Each passenger event has its own ID in passengerEvents[].eventId. |
| occurredAt | string | RFC 3339 timestamp of when the undo occurred. |
| createdAt | string | RFC 3339 timestamp of when the event was created in the system. |
| route | object | The ridership route on which this event occurred. |
| id | string | ID of the route. |
| externalIds | object | A map of external IDs associated with the route. Only present if the route has external IDs configured. |
| tags | array | Tags assigned to the route. Always present. Empty array when none. Each entry is {id, name, parentTagId?}. |
| actualStop | object | The stop where the undo was initiated. Only present if the undo occurred at a stop. |
| id | string | ID of the stop. |
| externalIds | object | A map of external IDs associated with the stop. Only present if the stop has external IDs configured. |
| boardingMethod | string | Method used for the original boarding. "rfid" means the action was performed using an RFID scan. "manual" means the action was performed manually by the driver. |
| passengerEvents | array | One entry per passenger whose boarding was undone. Always present. May be empty. |
| eventId | string | Unique ID for this passenger event. |
| plannedStop | object | Planned boarding stop, when the known passenger has a route assignment. |
| id | string | ID of the planned stop. |
| externalIds | object | A map of external IDs associated with the planned stop. |
| passenger | object | Passenger identity. Its type is known, anonymous, or unregistered. |
| type | string | "known" means the passenger has a profile. "anonymous" means the passenger is recorded without a profile or scanned identifier. "unregistered" means the passenger is identified by a scanned identifier but has no profile. |
| id | string | Passenger profile ID for a known passenger. |
| identifier | object | Identifier such as an RFID card, when present. Contains {type, value}. |
| type | string | Identifier type. "rfid" means an RFID identifier, such as an RFID card. |
| value | string | The value of the scanned identifier, such as an RFID card tag value. |
| externalIds | object | Customer external IDs for the known passenger, when configured. |
| tags | array | Tags assigned to the known passenger. May be empty. |
| isBulk | boolean | Whether this was a bulk undo operation. |
Passenger Drop Off Undo
Produced when a previous passenger drop-off is undone (reversed).
Example
{
"eventType": "passengerDropOffUndo",
"eventId": "0193f8a4-7e1c-7000-8000-000000000011",
"occurredAt": "2026-04-15T15:10:00Z",
"createdAt": "2026-04-15T15:10:01Z",
"route": {
"id": "98765",
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
},
"actualStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"dropOffMethod": "rfid",
"passengerEvents": [
{
"eventId": "0193f8a4-7e1c-7000-8000-000000000011",
"plannedStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"passenger": {
"type": "known",
"id": "0193f8a4-0000-7000-8000-000000000100",
"identifier": {
"type": "rfid",
"value": "E00401007B3E1726"
},
"externalIds": {
"customer.studentId": "STU-2046"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
}
}
],
"isBulk": false
}Reference
| Property Name | Type | Description |
|---|---|---|
| eventType | string | Always "passengerDropOffUndo". |
| eventId | string | Unique identifier for this undo event. For a bulk action, this is the ID of the entire action. Each passenger event has its own ID in passengerEvents[].eventId. |
| occurredAt | string | RFC 3339 timestamp of when the undo occurred. |
| createdAt | string | RFC 3339 timestamp of when the event was created in the system. |
| route | object | The ridership route on which this event occurred. |
| id | string | ID of the route. |
| externalIds | object | A map of external IDs associated with the route. Only present if the route has external IDs configured. |
| tags | array | Tags assigned to the route. Always present. Empty array when none. Each entry is {id, name, parentTagId?}. |
| actualStop | object | The stop where the undo was initiated. Only present if the undo occurred at a stop. |
| id | string | ID of the stop. |
| externalIds | object | A map of external IDs associated with the stop. Only present if the stop has external IDs configured. |
| dropOffMethod | string | Method used for the original drop-off. "rfid" means the action was performed using an RFID scan. "manual" means the action was performed manually by the driver. |
| passengerEvents | array | One entry per passenger whose drop-off was undone. Always present. May be empty. |
| eventId | string | Unique ID for this passenger event. |
| plannedStop | object | Planned drop-off stop, when the known passenger has a route assignment. |
| id | string | ID of the planned stop. |
| externalIds | object | A map of external IDs associated with the planned stop. |
| passenger | object | Passenger identity. Its type is known, anonymous, or unregistered. |
| type | string | "known" means the passenger has a profile. "anonymous" means the passenger is recorded without a profile or scanned identifier. "unregistered" means the passenger is identified by a scanned identifier but has no profile. |
| id | string | Passenger profile ID for a known passenger. |
| identifier | object | Identifier such as an RFID card, when present. Contains {type, value}. |
| type | string | Identifier type. "rfid" means an RFID identifier, such as an RFID card. |
| value | string | The value of the scanned identifier, such as an RFID card tag value. |
| externalIds | object | Customer external IDs for the known passenger, when configured. |
| tags | array | Tags assigned to the known passenger. May be empty. |
| isBulk | boolean | Whether this was a bulk undo operation. |
Unrecognized RFID Scan
Produced when an RFID tag is scanned but does not match any known passenger in the system. This event is emitted only when the organization chooses to record unrecognized scans without treating them as passenger pickup or drop-off. When the organization enables pickup and drop-off for unregistered passengers, the scan produces a passengerOnboard or passengerDropOff event instead.
Note: This event type does not include passengerEvents, boardingMethod, dropOffMethod, or isBulk fields.
Example
{
"eventType": "unrecognizedRfidScan",
"eventId": "0193f8a4-7e1c-7000-8000-000000000020",
"occurredAt": "2026-04-15T14:31:00Z",
"createdAt": "2026-04-15T14:31:01Z",
"route": {
"id": "98765",
"externalIds": {
"customer.runTemplateId": "28042464"
},
"tags": [
{
"id": "3914",
"name": "East Coast",
"parentTagId": "4815"
}
]
},
"actualStop": {
"id": "54321",
"externalIds": {
"customer.stopTemplateId": "508166310"
}
},
"location": {
"latitude": 37.7749123,
"longitude": -122.4194155
},
"identifier": {
"type": "rfid",
"value": "E00401007BUNKNOWN"
}
}Reference
| Property Name | Type | Description |
|---|---|---|
| eventType | string | Always "unrecognizedRfidScan". |
| eventId | string | Unique identifier for this event. |
| occurredAt | string | RFC 3339 timestamp of when the scan occurred. |
| createdAt | string | RFC 3339 timestamp of when the event was created in the system. |
| route | object | The ridership route on which this scan occurred. |
| id | string | ID of the route. |
| externalIds | object | A map of external IDs associated with the route. Only present if the route has external IDs configured. |
| tags | array | Tags assigned to the route. Always present. Empty array when none. Each entry is {id, name, parentTagId?}. |
| actualStop | object | The stop where the scan occurred. Only present if the event is associated with a stop. |
| id | string | ID of the stop. |
| externalIds | object | A map of external IDs associated with the stop. Only present if the stop has external IDs configured. |
| location | object | Location where the event occurred. Contains {latitude, longitude}. Omitted when location data is unavailable or does not meet quality requirements. |
| identifier | object | Identifier that was scanned, such as an RFID card. Contains {type, value}. |
| type | string | Identifier type. "rfid" means an RFID identifier, such as an RFID card. |
| value | string | The RFID tag value that was scanned but not recognized. |
Notes
Kafka Partition Key
All ridership events use the route ID as the Kafka partition key. This ensures that events for the same route are delivered to the same partition and arrive in order.
Field Presence
Fields shown in bold in the reference tables are always present. Non-bold fields are conditional and will be omitted from the payload when they have no value (empty string, zero, or nil). location is optional on pickup, drop-off, and unrecognized RFID scan events. It describes where the event occurred and is omitted when location data is unavailable or does not meet quality requirements. It is also omitted when customer location output is disabled.
External IDs
The externalIds fields on route, actualStop, plannedStop, and a known passenger are maps of key-value string pairs. These represent customer-configured external identifiers that link Samsara entities to external systems. They are only present when the entity has external IDs configured.
Timestamps
All timestamps (occurredAt, createdAt) are in RFC 3339 format (e.g., "2026-04-15T14:30:00Z").
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 9 days ago
Did this page help you?