Overview

Introduction

Return events are used to communicate information and actions performed in the Maven system back to an integrating customer. Generally speaking, all return events represent transactional events that are performed by users of the Maven system whether it be drivers, dispatchers, or planners. A single return event is meant to encapsulate a business level action that performed that contains all the necessary data to update downstream systems (whether it be internal transactional databases, reporting systems, customer notifications, etc...).

Maven provides a large library of return event types that span actions across all of our products.

Each return event is a JSON object contains the following properties:

• An id unique event identifier.
• A timestamp in UTC format denoting when the return event was produced.
• An eventType describing the format of the return event data.
• The data for the return event.

Ingesting Return Events

GET /return-events HTTP Endpoint (Polling)

The standard method of receiving return events is by calling the GET /return-events HTTP endpoint where return events can be fetched from a queue in the order that they were generated in the Maven system. If using this method of integration, it is recommended to create a program that polls this endpoint at a fixed time interval (every 30 seconds - 1 minute is common).

Each event in the Maven system is stored for 30 days from the date of creation. After 30 days, the event is deleted from the system and can no longer be read..