Events Overview

The Events API informs when any entity has been created, updated, or destroyed. For example, when a new order is created, an Order Created event is dispatches, or when a transaction occurs in a customer account, a Transaction Created event.

📘

Full Guide Available

Visit 🔒 the Amazon SQS Integration guide for more details on how to best connect and utilize the Events system, including recommended approaches for stored vs. cached data.

The state of an entity at the time of change is embedded in the event's payload array. As an example, an orders.updated event will provide the status update of the order in the payload.

The event object will contain all the relevant information about what happened, including the type of event and the data associated with that event. DriveWealth will send the events object directly to an SQS queue.