Emit Event Rule
The Emit event rule allows you to emit an event to BizzStream's event framework. This rule is crucial for integrating your workflows with BizzStream's event-driven architecture, enabling other parts of your system or external listeners to react to specific occurrences within your documents.
How to Add and Configure the Emit Event Rule
- Create a new user action by dragging it into the workflow and connect it to Any status or any other status block.
- The user action created should have a label and name. For example, 'Save'.
- Add a new action rule.
- Under
Type, selectEmit Event. - Enter a readable Label for the action rule.
- Enter a Description for the action rule.
- Configure the properties of the rule type as detailed below.
- Click Save to finalize the rule configuration.
- Finally, click Save in the action properties pane to apply the changes.
Properties
| Field | Required | Purpose |
|---|---|---|
| Event Type | Yes | The type of the event. This name is used for event listeners and methods to listen to this specific type. |
| Event Info | Yes | A JSON object that contains the info of the event. This object may contain BizzStream expressions. For instance, the value { code: {{F["code"]}} } will result in an object containing the code field from the document that is being processed. |
| Delay in transaction | No | Only visible when the action is transactional. When enabled, the event is not emitted immediately — instead it is queued and emitted only after the transaction has been committed successfully. This prevents downstream listeners from acting on data that may still be rolled back. |