Skip to content

Latest commit

 

History

History
34 lines (27 loc) · 1.56 KB

event-structure.md

File metadata and controls

34 lines (27 loc) · 1.56 KB

Event Structure

Eiffel events are represented as JSON objects. These JSON objects contain three required members: meta, data and links.

meta

Type: Object
Required: Yes
Description: This object contains fields common to all event types: meta-data describing the event itself. It is described in detail here.

data

Type: Object
Required: Yes
Description: This object contains all fields specific to the event type – the payload of the event – including trace links to non-Eiffel entities. It is described in detail per event type.

links

Type: Object
Required: Yes
Description: This object contains all types of links to other Eiffel events. Its usage and syntax is described here, while the full list of optional and required links is described in the documentation of each respective event type..