Journey Events API 1.0.0 documentation

AsyncAPI documentation for the Journey Events stream. The Journey Events stream publishes lifecycle events for vehicle trips in near real time. A journey emits events as it starts, updates while in progress, and ends when completed. What this stream provides

Journey lifecycle state (start, update, end)
Vehicle, customer, and driver identifiers for correlation
Start/end location and address context
Distance, duration, speed, and fuel/energy metrics
Driver behaviour counters and operational indicators
Place and input enrichments (spl, epl, ins)

Typical usage

Monitor journey progress in operational dashboards
Trigger downstream workflows on start/update/end transitions
Build analytics for utilisation, efficiency, and safety

Message model

Topic: mn_journey_events
Message: JourneyEvent
Payload schema: JourneyEventPayload

Servers
- kafka
Operations
- RECEIVE mn_journey_events

Servers

`kafka` Server

URL: kafka-secure://{brokerHost}:{brokerPort}/
Protocol: kafka-secure

URL Variables

Name	Description	Default value	Allowed values
brokerHost	Kafka broker hostname	`localhost`	Any
brokerPort	Kafka broker port	`9092`	Any

Security

Security Requirement 1

security.protocol: SASL_SSL
sasl.mechanism: OAUTHBEARER

Operations

RECEIVE `mn_journey_events` Operation

Receive journey events

Operation ID: receiveJourneyEvent

Channel for journey events (start, update, end) Receives journey events when a journey starts, updates, or ends. The ‘state’ field indicates the journey lifecycle stage:

‘start’: Journey has started
‘update’: Journey data has been updated
‘end’: Journey has completed

Message Journey Event `JourneyEvent`

*An event representing a vehicle journey *

Message ID: journeyEvent
Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	-	-	-	additional properties are allowed
id	string	Unique identifier of the journey	-	-	required
cid	string	Customer identifier	-	-	required
aid	string	Asset (vehicle) identifier	-	-	required
ar	string	Asset registration number	-	-	-
pid	string	Person (driver) identifier	-	-	-
dk	string	Driver key for identification	-	-	-
sid	integer	Sequence identifier for ordering events	-	format (`int64`)	-
sdt	string	Shard date time for data partitioning	-	-	-
state	string	Journey lifecycle state	allowed (`"start"`, `"update"`, `"end"`)	-	required
isUpdate	boolean	Flag indicating if this is an update event	-	-	-
ahnid	string	Asset hierarchy node identifier	-	-	-
phnid	string	Person hierarchy node identifier	-	-	-
st	integer	Start time in epoch milliseconds	-	format (`int64`)	-
et	integer	End time in epoch milliseconds	-	format (`int64`)	-
cti	integer	Created time in epoch milliseconds	-	format (`int64`)	-
lmt	integer	Last modified time in epoch milliseconds	-	format (`int64`)	-
sjpt	integer	Start journey processed time	-	format (`int64`)	-
start.long	number	Start coordinate longitude	-	format (`double`)	-
start.lat	number	Start coordinate latitude	-	format (`double`)	-
sa	string	Start address	-	-	-
end.long	number	End coordinate longitude	-	format (`double`)	-
end.lat	number	End coordinate latitude	-	format (`double`)	-
ea	string	End address	-	-	-
dkms	number	Distance traveled in kilometers	-	format (`double`)	-
maxspdkph	number	Maximum speed in kilometers per hour	-	format (`float`)	-
startodo	number	Start odometer reading	-	format (`double`)	-
endodo	number	End odometer reading	-	format (`double`)	-
odotype	string	Odometer type (e.g., GPS, CAN)	-	-	-
mwopds	integer	Moving without PTO duration in seconds	-	format (`int64`)	-
mwpds	integer	Moving with PTO duration in seconds	-	format (`int64`)	-
iwopds	integer	Idling without PTO duration in seconds	-	format (`int64`)	-
iwpds	integer	Idling with PTO duration in seconds	-	format (`int64`)	-
fu	number	Total fuel used	-	format (`double`)	-
sfl	number	Start fuel level	-	format (`float`)	-
efl	number	End fuel level	-	format (`float`)	-
sflp	number	Start fuel level percentage	-	format (`float`)	-
eflp	number	End fuel level percentage	-	format (`float`)	-
sfll	number	Start fuel level in litres	-	format (`float`)	-
efll	number	End fuel level in litres	-	format (`float`)	-
fupi	number	Fuel used during PTO idling	-	format (`double`)	-
fui	number	Fuel used during idling	-	format (`double`)	-
seth	number	Start engine total hours	-	format (`float`)	-
eeth	number	End engine total hours	-	format (`float`)	-
sath	number	Start asset total hours	-	format (`float`)	-
eath	number	End asset total hours	-	format (`float`)	-
evkwhc	number	EV consumption in kWh	-	format (`float`)	-
evkwhce	boolean	EV kWh consumption is estimated	-	-	-
evsrk	number	EV start range in km	-	format (`float`)	-
everk	number	EV end range in km	-	format (`float`)	-
evsrke	boolean	EV start range km is estimated	-	-	-
everke	boolean	EV end range km is estimated	-	-	-
evssocp	number	EV start state of charge percentage	-	format (`float`)	-
evesocp	number	EV end state of charge percentage	-	format (`float`)	-
evssocpe	boolean	EV start state of charge percentage is estimated	-	-	-
evesocpe	boolean	EV end state of charge percentage is estimated	-	-	-
gkgc	number	Gas consumption in kg	-	format (`float`)	-
dbeorc	integer	Driver behaviour engine over revving count	-	format (`int64`)	-
dbhac	integer	Driver behaviour harsh acceleration count	-	format (`int64`)	-
dbhbc	integer	Driver behaviour harsh braking count	-	format (`int64`)	-
dbhcc	integer	Driver behaviour harsh cornering count	-	format (`int64`)	-
dbsec	integer	Driver behaviour speeding event count	-	format (`int64`)	-
dbeiibc	integer	Driver behaviour excessive idling inside base count	-	format (`int64`)	-
dbeiobc	integer	Driver behaviour excessive idling outside base count	-	format (`int64`)	-
dbfec	integer	Driver behaviour fatigue event count	-	format (`int64`)	-
dbsmec	integer	Driver behaviour smoking event count	-	format (`int64`)	-
dbdec	integer	Driver behaviour distraction event count	-	format (`int64`)	-
dbndec	integer	Driver behaviour no driver event count	-	format (`int64`)	-
dbldec	integer	Driver behaviour lane departure event count	-	format (`int64`)	-
dbfcwec	integer	Driver behaviour forward collision warning event count	-	format (`int64`)	-
dblhiec	integer	Driver behaviour left hand indicator event count	-	format (`int64`)	-
dbrhiec	integer	Driver behaviour right hand indicator event count	-	format (`int64`)	-
dbvrec	integer	Driver behaviour vehicle reversing event count	-	format (`int64`)	-
dbmpwec	integer	Driver behaviour mobile phone warning event count	-	format (`int64`)	-
dbfdwec	integer	Driver behaviour following distance warning event count	-	format (`int64`)	-
dbsbuec	integer	Driver behaviour seatbelt unfastened event count	-	format (`int64`)	-
dbpsbuec	integer	Driver behaviour passenger seatbelt unfastened event count	-	format (`int64`)	-
dbfdec	integer	Driver behaviour food/drink event count	-	format (`int64`)	-
dbvec	integer	Driver behaviour vibration event count	-	format (`int64`)	-
sdmttp.count	integer	Speeding by more than 10% count	-	-	-
sdmttp.dkm	number	Speeding by more than 10% distance in km	-	format (`double`)	-
sdmttp.ds	integer	Speeding by more than 10% duration in seconds	-	format (`int64`)	-
iabt	array<number>	Idling at base times	-	-	-
iabt (single item)	number	-	-	format (`double`)	-
iafbt	array<number>	Idling away from base times	-	-	-
iafbt (single item)	number	-	-	format (`double`)	-
if	integer	Idling fidelity indicator	-	-	-
pri	boolean	Whether the journey is private	-	-	-
hj	boolean	Whether to hide the journey	-	-	-
clas	string	Journey classification	-	-	-
txjs	string	Tax and expense journey state	-	-	-
nt	string	Notes associated with the journey	-	-	-
pto	boolean	PTO (Power Take-Off) enabled flag	-	-	-
eaf	boolean	Expense amended flag	-	-	-
synt	boolean	Whether the journey is synthetic	-	-	-
exp.poTr	string	Purpose of trip	-	-	-
exp.amdkm	number	Amended distance in kilometers	-	format (`double`)	-
exp.amr	string	Amended reason	-	-	-
exp.amscoord.long	number	Amended start coordinate longitude	-	format (`double`)	-
exp.amscoord.lat	number	Amended start coordinate latitude	-	format (`double`)	-
exp.amecoord.long	number	Amended end coordinate longitude	-	format (`double`)	-
exp.amecoord.lat	number	Amended end coordinate latitude	-	format (`double`)	-
exp.amstxt	string	Amended start address text	-	-	-
exp.ametxt	string	Amended end address text	-	-	-
spl	array<object>	Start places	-	-	-
spl.id	string	Place identifier	-	-	-
spl.nm	string	Place name	-	-	-
spl.plcid	string	Place category identifier	-	-	-
spl.plcnm	string	Place category name	-	-	-
epl	array<object>	End places	-	-	-
epl.id	string	Place identifier	-	-	-
epl.nm	string	Place name	-	-	-
epl.plcid	string	Place category identifier	-	-	-
epl.plcnm	string	Place category name	-	-	-
ins	array<object>	Input counts and magnitudes	-	-	-
ins.inid	string	Input identifier	-	-	-
ins.incnt	integer	Input count	-	format (`int64`)	-
ins.indsec	integer	Input duration in seconds	-	format (`int64`)	-
ins.indkm	number	Input distance in kilometers	-	format (`double`)	-
ins.infu	number	Input fuel used	-	format (`double`)	-
af	array<string>	Asset feature tags	-	-	-
af (single item)	string	-	-	-	-
ip	array<string>	Interested parties	-	-	-
ip (single item)	string	-	-	-	-
ipt	array<string>	Interested party tags	-	-	-
ipt (single item)	string	-	-	-	-
tags	array<string>	Journey tags	-	-	-
tags (single item)	string	-	-	-	-
bt	array<string>	Box types	-	-	-
bt (single item)	string	-	-	-	-
enrg	object	Energy consumption data	-	-	additional properties are allowed
scc	string	Submitted currency code	-	-	-
sr	number	Submitted rate	-	format (`double`)	-
jgh	array<string>	Journey geohashes for spatial indexing	-	-	-
jgh (single item)	string	-	-	-	-
laid	string	Linked asset identifier	-	-	-
lan	string	Linked asset name	-	-	-
lar	string	Linked asset registration	-	-	-

Examples of payload

journeyStartExample A journey start event

{
  "id": "journey-1001",
  "cid": "customer-001",
  "aid": "asset-101",
  "ar": "AB12CDE",
  "pid": "driver-501",
  "dk": "driver-key-501",
  "sid": 1,
  "sdt": "2026-03-27T08:15:00Z",
  "state": "start",
  "isUpdate": false,
  "st": 1774599300000,
  "cti": 1774599301000,
  "lmt": 1774599301000,
  "start.long": -0.1278,
  "start.lat": 51.5074,
  "sa": "London Depot, UK",
  "spl": [
    {
      "id": "place-ldn-depot",
      "nm": "London Depot",
      "plcid": "depot",
      "plcnm": "Depot"
    }
  ],
  "ins": [
    {
      "inid": "pto",
      "incnt": 0,
      "indsec": 0,
      "indkm": 0,
      "infu": 0
    }
  ],
  "af": [
    "gps",
    "can"
  ],
  "tags": [
    "business",
    "morning-run"
  ]
}

journeyUpdateExample An in-progress journey update event

{
  "id": "journey-1001",
  "cid": "customer-001",
  "aid": "asset-101",
  "ar": "AB12CDE",
  "pid": "driver-501",
  "dk": "driver-key-501",
  "sid": 2,
  "sdt": "2026-03-27T08:30:00Z",
  "state": "update",
  "isUpdate": true,
  "st": 1774599300000,
  "cti": 1774600200000,
  "lmt": 1774600200000,
  "dkms": 12.7,
  "maxspdkph": 68.4,
  "start.long": -0.1278,
  "start.lat": 51.5074,
  "sa": "London Depot, UK",
  "fu": 1.9,
  "dbhac": 1,
  "dbhbc": 0,
  "dbsec": 1,
  "iabt": [
    120
  ],
  "if": 1,
  "spl": [
    {
      "id": "place-ldn-depot",
      "nm": "London Depot",
      "plcid": "depot",
      "plcnm": "Depot"
    }
  ],
  "ins": [
    {
      "inid": "pto",
      "incnt": 1,
      "indsec": 240,
      "indkm": 3.2,
      "infu": 0.4
    }
  ],
  "af": [
    "gps",
    "can"
  ],
  "tags": [
    "business",
    "delivery"
  ]
}

journeyEndExample A completed journey end event

{
  "id": "journey-1001",
  "cid": "customer-001",
  "aid": "asset-101",
  "ar": "AB12CDE",
  "pid": "driver-501",
  "dk": "driver-key-501",
  "sid": 3,
  "sdt": "2026-03-27T09:05:00Z",
  "state": "end",
  "isUpdate": false,
  "st": 1774599300000,
  "et": 1774602300000,
  "cti": 1774602300000,
  "lmt": 1774602300000,
  "start.long": -0.1278,
  "start.lat": 51.5074,
  "sa": "London Depot, UK",
  "end.long": -0.1425,
  "end.lat": 51.501,
  "ea": "Westminster, London, UK",
  "dkms": 28.4,
  "maxspdkph": 74.1,
  "startodo": 15432.1,
  "endodo": 15460.5,
  "odotype": "GPS",
  "fu": 4.6,
  "sflp": 78,
  "eflp": 72.5,
  "dbhac": 1,
  "dbhbc": 1,
  "dbsec": 2,
  "pri": false,
  "pto": false,
  "spl": [
    {
      "id": "place-ldn-depot",
      "nm": "London Depot",
      "plcid": "depot",
      "plcnm": "Depot"
    }
  ],
  "epl": [
    {
      "id": "place-westminster",
      "nm": "Westminster",
      "plcid": "customer-site",
      "plcnm": "Customer Site"
    }
  ],
  "ins": [
    {
      "inid": "pto",
      "incnt": 1,
      "indsec": 240,
      "indkm": 3.2,
      "infu": 0.4
    }
  ],
  "af": [
    "gps",
    "can"
  ],
  "tags": [
    "business",
    "delivery"
  ]
}

Download AsyncAPI Specification

Journey Events AsyncAPI Specification

Stream API Documentation

Journey events

Journey Events API 1.0.0 documentation

Table of Contents

Servers

`kafka` Server

URL Variables

Security

Security Requirement 1

Operations

RECEIVE `mn_journey_events` Operation

Message Journey Event `JourneyEvent`

Payload

Download AsyncAPI Specification

Stream API Documentation

​Journey Events API 1.0.0 documentation

​Table of Contents

​Servers

​kafka Server

​URL Variables

​Security

Security Requirement 1

​Operations

​RECEIVE mn_journey_events Operation

​Message Journey Event JourneyEvent

Payload

​Download AsyncAPI Specification

Journey Events API 1.0.0 documentation

Table of Contents

Servers

`kafka` Server

URL Variables

Security

Operations

RECEIVE `mn_journey_events` Operation

Message Journey Event `JourneyEvent`

Download AsyncAPI Specification