Skip to main content

Custom Message

Custom Message allows personalizing and configuring the end message according to preference. The title, description, and logo can be customized, ensuring the message aligns perfectly with needs and intentions.

Additionally, when you add multiple validators in a flow, you can customize the end message for each path according to the specific use case of that particular validator. This allows for more targeted and relevant messaging based on the outcome of the validation process.

How to Setup

1 Go to Workspace > Workflows, and click on the flow created for Custom Message. If you need understanding in creating a workflow, refer to the step-by-step guide here.

Make sure a preceding workflow is added and completed for the custom message to appear, as it will display after the workflow is executed. For instance, Validate Aadhaar is used here.

Note that, the custom message is triggered when the preceding workflow is fully executed and reaches the custom message step. For example, if there are five workflow modules configured before the custom message, and the verification process ends after the third module, the message set at the application level will be displayed.

2 Hover over the plus (+) symbol and select Workflow. From the list, click Custom Message to add it.

Custom Message

3 Click on the newly added workflow, then select the General tab to customize your preferences.

General

Manage General

(*) Indicates an action to be mandatory.

NameDescription
*Display NameSet a name to the workflow for easy identification.
DescriptionSummarize the purpose and functionality of this workflow module.
EnableThis toggle is enabled by default. When enabled, the particular workflow module begins its execution. Conversely, if disabled, the workflow module remains inactive and won't proceed.
RuleThis determines the criteria for triggering the particular workflow module. When the selected rule is evaluated, and is satisfied, the workflow proceeds as provided. If not, the workflow will not be executed. Note: If no rules are set, the workflow defaults to its standard action without any rule. For more information about the rules, refer here.

4 Then, click on the Configs tab to set the necessary configurations.

Configs

Manage Configs

(*) Indicates an action to be mandatory.

NameDescription
*LogoUpload a logo that will be displayed alongside the custom message once the workflow is completed.
*TitleSpecify the title for the custom message that will appear at the end of the workflow execution.
*DescriptionProvide the description for the custom message that will be shown once the workflow has been executed.

5 After you've configured everything needed, click on SAVE.

6 Proceed to attach the workflow to the relevant application for execution. Refer to the instructions on how to attach a workflow to an application here.

How it Works

1 Launch Postman or your preferred API tool and execute the flow by configuring the suitable Method, URL, and Body settings. If you're seeking guidance on how to perform these actions, see here.

2 Upon initiating the API call, a verification request will be sent to your configured Verification Way settings.

3 Based on the request, execute the flow in an incognito browser and follow the prompts to complete the verification process.

4 Since Validate Aadhaar is configured, begin by providing the Aadhaar Number, and click on Submit.

Aadhaar

5 The verification process will be completed if the entered data is valid, and the custom message you configured will then appear.

Verification Completed