Event Specification Block
Document event-driven architecture events with producers, consumers, payload schemas, trigger conditions, and frequency. Define clear contracts for asynchronous communication.
The Event Specification block documents events in event-driven architectures. It captures the event name, version, producers, consumers, payload schema, trigger conditions, and expected frequency.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Event Name | Yes | The name of the event |
| Version | No | Event schema version (e.g., 2.1.0) |
| Description | No | What the event represents |
| Producers | No | Array of services that publish this event |
| Consumers | No | Array of services that subscribe to this event |
| Trigger Conditions | No | When the event fires |
| Frequency | No | Expected event frequency (real-time, daily, etc.) |
| Payload Schema | No | JSON schema or payload description |
Frequency Values
Example: Order Created Event
A domain event fired when a new order is placed.
Example: User Registration Event
An event for new user sign-ups.
Example: Inventory Low Stock Alert
A monitoring event for inventory levels.
Example: Batch Processing Complete
A batch job completion event.