Overview

Events Notifications

This documentation describes the process of publishing & delivering business event notifications from a vehicle's auction life cycle. The source application data repository or API endpoint publishes an auction event. The consumer subscribes to these events to receive real time auction information.

Benefits of using Event Notification:

• Customer will get updates for the vehicle in real time as it moves through the auction system. For example- A customer will receive CONSIGNMENT.CREATED event for a particular vehicle as soon as it enters into the auction system.
• All Manheim applications such as Inventory, Images or Valuations that support the auction life cycle are notified through events. Customer will receive real time events as soon as vehicle information is updated in the auction or its underlying applications.
• With event notifications, customers can receive business updates through API endpoints without having to actually call them directly.
• Customer provides event filters while subscribing to events. These filters then allows customer to specify a particular stream of events that impacts their business while ignoring others. For example, a customer can track the life cycle of a particular car in auction by subscribing for events by VIN.
• Real time events allows customer application to run in sync with auction updates, nullifying the need for batch job or reports for data support.

Process to publish events by System of Records

• Events are published by their system of record as vehicle information changes in auction. For example, the Inventory system publishes UNITS.CREATED or CONSIGNMENTS.CREATED events when a vehicle enters into the auction system.
• Event contain a header that lists the event name. This name is combination of noun & verb that is related to auction activity.
• Event contain a body that is thin in structure. The body contains the specific data & API endpoints urls for the business process it supports. For example, UNITS.CREATED carries the VIN# & Unit url endpoint.
• Event contain an event created date that indicates when the particular event actually happened. For example, the created date in CONSIGNMENTS.CREATED event provides information as to when the vehicle entered the auction system.
• More information about events is available in Events page.

Process to receive events

• Customer will create subscribers for his company. This registers the company for event notification. Subscribers provides details.
• Customer will create subscriptions for events that they need to receive. Subscriptions are created under registered subscribers. Subscriptions provides details for this.
• Customer can use /expand endpoint to request the delivery of the event with embedded API endpoint response. Expander provides details.