By using Response Templates you can make sure to map the response your Bots get to map them properly in your Workflows. Bot Response Templates are part of the Nimbus Virtual User configuration.
Configuring Bot Response Templates
| Field | Description |
|---|---|
| Name | Name of the Bot Response Template as it appears in Nimbus lists and selections. |
| Organization Unit | Determines where the Bot Response Template will be available for selection. |
| Description | Description of the Bot Response Template, used in Nimbus listings and UI areas. |
BEFORE YOU START:
-
JSON Mapping: For the mappings to work you need to configure and inspect the JSON output of your Bots and their associated API.
💡 We have prepared an example below to illustrate the “M365 CoPilot Direct Line” case. - Application in Nimbus: The entire set of each Bot choice, Request- and Response Template is collected within a Virtual User configuration. The mapping is essential for the “Add Virtual User” Conversation Handling Activity to function as intended within your Workflows.
System Field Mapping
This section allows to map generated Bot answers to Nimbus variables.
☝IMPORTANT: All mappings below must be formatted in JSONPath syntax. Other formats or syntax errors will be rejected.
| Field | Description |
|---|---|
| Answer Raw |
Identifies where in the response the raw answer value from the Bot can be found. ✅ Necessary related action: Nimbus will use this answer for “Text to Speech” interpretation as input for the “Add Virtual User” Conversation Handling Activity. Without this mapping there will be no audible dialogue coming from the bot. 💡This field contains raw or unprocessed response generated by the Bots, prior to any formatting or refinement. |
| Exit |
Identifies where in the response the ✅ Necessary related action: Nimbus will use this answer for “Exit” validation of the “Add Virtual User” Conversation Handling Activity. Without this mapping the activity will get no answer to validate (e.g. via Regular Expressions). 💡This field indicates whether the conversation or interaction should be terminated. For example, if the Customer indicates they want to end the conversation, this field can indicate " |
|
Answer Formatted (optional) |
Identifies where in the response the formatted answer value can be found. 💡Formatted answers can include HTML adjustments for readability, making it more User-friendly compared to the raw answer, but also harder to parse in further processing. |
Custom Field Mapping
| Field | Description |
|---|---|
| Custom Parameter |
Allows to map Nimbus Custom Parameters to the JSON response path. ✅ Precondition: You need to have an Organization Unit specified above for this list to show any Parameters 💡Examples: |
Example JSON Response
M365 CoPilot Direct Line 3.0 Json
The following JSON is returned from M365 CoPilot Direct Line 3.0, which is the default configuration of external Bots in Nimbus.
{
"type": "message",
"id": "5ZASDrgTOO0GtNlVtdgEE2-uk|0000021",
"timestamp": "2025-05-20T20:31:01.9981516Z",
"serviceUrl": "https://directline.botframework.com/",
"channelId": "directline",
"from": {
"id": "user1"
},
"conversation": {
"id": "5ZASDrgTOO0GtNlVtdgEE2-uk"
},
"locale": "en-EN",
"text": "hello, bot"
}Example for Copilot DirectLine: JSON to System Field Mapping
💡In the following we want to focus attention to the "text" portion of the JSON response above. As Nimbus identifies parameter with a $ sign, you can map the response as follows:
-
Required: Into the fields Answer Raw, Exit and Answer Formatted type:
$['text'] -
Optionally:
- Map the same
$['text']field to a Custom Parameter for later usage, e.g. within your Flow Actions. - Repeat this for any other Custom Parameters you want to map.
- Map the same
- The “Exit” mapping will use
$['text']contents for Exit condition check in your Conversation Handling Activities > “Add Virtual User” activity. Regular Expressions can be used to find the necessary words in a response.