Use the Events API to receive real-time messages for your fleet. This allows you to react instantly and to keep your data up to date. The INVERS OneAPI is capable of delivering events through AMQP, e.g. when a new vehicle state is recorded or when the vehicle’s master data changes.
The Events API serves as an asynchronous messaging mechanism and not as long-term storage. If you have not consumed and acknowledged a message from a given queue for three consecutive days, the queue and all messages contained within are deleted and will not be delivered to you anymore.
- Each event has a
typewhich uniquely identifies what kind of event it is. In an “object-oriented” perspective, the
typecan be seen as the class of the event. The event type also indicates what kind of information (which properties) are present in all events of that particular type.
- A topic is a collection of one or more event types. You can subscribe to an event topic, and by doing so you can consume all events which are part of that topic. You can subscribe to multiple topics.
- When you subscribe to a topic, an AMQP queue is created for the topic. You can access the queue to consume the topic’s events (as messages on this particular AMQP queue).
All events that are pushed to you via Events API of the INVERS OneAPI have one of the following sources:
- Event from OneAPI
- The origin of these events is the INVERS OneAPI and not a vehicle. An example is the event
VehicleChangedwhich, for example, informs you that the license plate of the vehicle was changed.
- Event from a vehicle
- These events are sent regularly or when something happens at the vehicle. This requires the vehicle or, to be precise, the built-in telematics unit to be online. An example is the event
VehicleStateRecordedwhich, for example, informs you that the central lock status of the vehicle has changed (this event contains the vehicle state).
Consume Learn how to consume events
Format Learn more about the format of events
Versioning Learn how versioning helps to keep your integration intact
Event list See a list of all events that can be pushed to you