The plugin can be used for sending many kinds of notifications such as emails or SMS notifications. It can be easily integrated in one of your business processes.
To configure a business process that sends notifications you must follow the next steps:
DEVELOPER: Make sure the needed Kafka topics are configured properly.
Kafka topic names can be set by using the following environment variables:
KAFKA_TOPIC_NOTIFICATION_INTERNAL_IN
- topic used to trigger the request to send a notificationKAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT
- topic used for sending replies after sending the notificationThe following values are expected in the request body:
Key | Definition | |
---|---|---|
language | The language that should be used | Mandatory |
templateName | The name of the notification template that is used | Mandatory |
channel | Notification channel: SMS/MAIL | Mandatory |
receivers | Notification receivers: email/phone number | Mandatory |
senderEmail | Notification sender email | Optional |
senderName | Notification sender name | Optional |
attachments | Attachments that are sent with the notification template (only used for MAIL notifications) | Optional |
Check the detailed example below.
Let’s pick a simple use-case, say we need to send a new welcome letter when we onboard a new customer. The steps are the following:
KAFKA_TOPIC_NOTIFICATION_INTERNAL_IN
- (in our example, flowx-notifications-qa
)You can check the defined topics by going to FlowX Designer > Platform Status > notification-plugin-mngt > kafkaTopicsHealthCheckIndicator > details > configuration > topic > notifications.
{"processInstanceId": ${processInstanceId}}
KAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT
- (in our example, ai.flowx.updates.qa.notification.request.v1
).KAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT
variable.Response example at KAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT
: