Skip to main content

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

Table of Contents

Servers

kafka Server

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

URL Variables

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 *
Payload
Examples of payload
journeyStartExample A journey start event
journeyUpdateExample An in-progress journey update event
journeyEndExample A completed journey end event

Download AsyncAPI Specification

Journey Events AsyncAPI Specification