Event Specification Block
Document domain events with producers, consumers, payload schemas, and trigger conditions.
Overview
The Event Specification block documents domain events in event-driven architectures. It captures event name, version, producers, consumers, payload schema, trigger conditions, and frequency. Use this block to create an event catalogue for system integration documentation.
Order Event
A domain event for order state changes.
Inventory Event
A batch inventory synchronisation event.
Block Properties
| Property | Required | Description |
|---|---|---|
| eventName | Yes | Name of the event |
| version | No | Event schema version |
| description | No | What the event represents and when it occurs |
| producers | No | Array of systems that emit this event |
| consumers | No | Array of systems that subscribe to this event |
| payloadSchema | No | Schema definition for the event payload |
| triggerConditions | No | Conditions that cause the event to be emitted |
| frequency | No | How often the event occurs |