Structure of an event

An event consists of an envelope and a payload. Depending on the topic, the payload contains different data types that match the models from the REST API.

Envelope

The event envelope provides metadata about the event. It contains the following fields:

• event: The topic of the event.

• payload: The data associated with the event.

• eventId: A unique identifier for the event.

{
  "event": "ORDER_CREATED",
  "payload": "<Typed payload depending on topic>",
  "eventId": "5993095975110686"
}

Payloads

To determine which payload corresponds to each event, refer to the documentation on Available Events. Events that refer to updated entities, such as FACILITY_UPDATED, always include the updated version of that entity in their payload.