Structure of an Event

This page is outdated. Please go to our new documentation under https://docs.fulfillmenttools.com/documentation.

An Event consists of an envelope and the payload. Depending on the topic the payload is of different types which match the types of the RESTful API models.

Envelope

{
  "event": "ORDER_CREATED", //Topic of the Event
  "payload": <Typed payload depending on topic>,
  "eventId": "5993095975110686" //eventId is unique to any event
}

Payloads

In order to find out which event carries which payload please see the section regarding Available Events. Events which refer to updated entities (e.g. FACILITY_UPDATED) always show the updated version of that entity in their payload.