Sending a notification

​

Configuring the notification process

1. Create or edit a notification template in FlowX Designer
2. Design your BPMN process in Process Designer with:
   • A send message task
   • A receive message task
3. Configure required node actions
4. Set up the request body parameters

​

Send notification request body parameters

​

Using dynamic keys

• Dynamic keys use the syntax ${...} to insert data from the process context
• The system fetches corresponding values from the specified data path
• This approach eliminates hardcoding and supports personalized content
• Example: ${application.client.firstName} retrieves and displays the client’s first name

{
  "templateName": "ClientRelationshipEmailConfirmation",
  "channel": "MAIL",
  "receivers": [
    "${application.client.email}"
  ],
  "language": "en",
  "data": {
    "firstInputClient": "${application.client.firstName}"
  },
  "attachments": [
    {
      "path": "${generatedDocument.generatedFiles.1234.ClientRelationshipDetails.minioPath}",
      "filename": "${generatedDocument.generatedFiles.1234.ClientRelationshipDetails.documentType}.pdf"
    }
  ]
}

​

Implementation example

1

Create a notification template

First, create and configure your welcome email template. See Managing notification templates for detailed instructions.With notification templates, you can:

• Set up subjects and body content with a WYSIWYG editor
• Add dynamic fields using the data model to include recipient-specific information
• Define multiple language versions of the same template
• Configure notification types and delivery channels

2

Design the BPMN process

Inside your project, create a process definition with:

• A User Task to capture the recipient’s email address and other user inputs if needed
• A Send Message Task
• A Receive Message Task

This pattern enables asynchronous notification handling through Kafka messaging.

3

Configure the send message task

On the send message task, add a Kafka send action with the following settings:

• Topics:
  • Use the value from KAFKA_TOPIC_NOTIFICATION_INTERNAL_IN environment variable
  • Example (in our case): flowx-notifications-devmain

To find defined topics in your environment:

1. Navigate to FlowX Designer > Platform Status
2. Select notification-plugin-mngt
3. Open kafkaTopicsHealthCheckIndicator > details > configuration > topic > notifications

• Message (expected parameters):
  • templateName (string)
  • channel (string)
  • language (string)
  • receivers (array) - usually extracted from process context but also can be a static value
• Can include: contentParams (object) for dynamic content, attachments (array) for emails

4

Configure the receive message task

• On the receive message task, add a data stream topic where you will receive the confirmation that the notification was sent:
  • Data stream topics:
    • Use the value from KAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT environment variable
    • Example (in our case): ai.flowx.updates.devmain.notification.request.v1

To add a data stream topic, follow the steps below:

1. On your Receive Message Task node, click on the Node Config tab.
2. Then under Data stream topics click Add stream.
3. Select Custom and enter the topic name from the KAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT environment variable.
4. Add a key where you will see the response added to the process instance.
5. Click Save.

To find the corresponding data stream topic in your environment follow the same steps as in the previous step

5

Run and verify the process

Execute the process and verify the results by:

• Checking the audit log
• Checking the process instance status
• Monitoring responses on the KAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT topic

When successful, you’ll receive a response on the KAFKA_TOPIC_NOTIFICATION_INTERNAL_OUT topic similar to this:

Response Example

Report incorrect code

Copy

Ask AI

{
  "identifier": null,
  "templateName": "welcomeLetter",
  "language": "en",
  "error": null
}

​

Integration with document generation

"attachments": [  
  {
    "path": "${generatedDocument.generatedFiles.1234.ClientRelationshipDetails.minioPath}",
    "filename": "${generatedDocument.generatedFiles.1234.ClientRelationshipDetails.documentType}.pdf"
  }
]

​

Troubleshooting