Using the plugin
After deploying the notifications plugin in your infrastructure, you can start sending notifications by configuring related actions in your process flow definitions.
Before adding the corresponding actions in your process definition, you will need to follow a few steps:
- make sure all prerequisites are prepared, for example, the notification templates you want to use
- the database is configured properly
- for each kafka event type, you will need two Kafka topics:
- one for the request sent from the engine to the plugin
- one for the corresponding reply
info
The topic names configured for the plugin should match the ones used when configuring the engine and when adding plugin-related process actions:
- the Engine is listening for messages on topics with names of a certain pattern, make sure to use an outgoing topic name that matches the pattern configured in the Engine
More details: here
- to make a request to the plugin, the process definition needs to have an action of type
Kafka send
that has an action parameter with keytopicName
and the needed topic name as a value - to receive a reply from the plugin, the process definition needs to have a receiving node with a node value with key
topicName
and the topic name as the value
After all the setup is in place, you can start adding custom actions to the processes.
Let's go through a few examples. These examples cover both the configuration part, and the integration with the engine for all the use cases.
»Managing notification templates»Send a notification»Send an email with attachments»Forward notifications to an external system»OTP flow