Emit an event
An event can be thought of as a signal that something significant has occurred within an environment.
Properties
Events have two properties that, together, form the backbone of an event's structure in BizzStream's event framework:
| Property | Description |
|---|---|
| Type | This is a string identifier that categorizes the event, enabling the model to recognize and differentiate it from others. The type should be descriptive label, making it easy for administrators and the model to understand the nature of the event. For instance, a type like PURCHASE_ORDER_CREATED clearly indicates that the event is triggered when a purchase order has been created. This specificity allows the system to route the event to the appropriate listeners designed to respond to that particular type of occurrence. These type identifiers can be named when making a new emit event. In the field Event Type. |
| Info | A JSON object containing additional details about the event. This information provides context and necessary data that the event listener might require to process the event appropriately. For example, in a PURCHASE_ORDER_CREATED event, the info property might contain details such as the order ID, customer information, order items, and timestamps. This rich information payload enables event listeners to execute more informed and specific operations, tailoring their response to the particularities of each event. |
Emitting events
Events within BizzStream can be triggered in three distinct ways, each offering an approach to suit different scenarios and requirements:
- Inside of a workflow by using the Emit Event action rule.
- As part of an script by using the bizzStream.emitEvent script method.
- By using the Emit Event REST call.
Listening to Events
To process and react to the events you've emitted, you will use the event listener. This component is essential for defining what actions are triggered when a specific event occurs. For detailed information on configuring and using event listeners, consult the documentation covering the Action Rule, Script Method or REST call.