Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots's Approach Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Platform
How to Access Bot Builder
Working with Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Bot Builder
Creating a Bot
Dialog Task
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Form Node
Logic Node
Message Nodes
Confirmation Nodes
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Grouping Nodes
Connections & Transitions
Managing Dialogs
Prompt Editor
Alert Tasks
Alert Tasks
Ignore Words and Field Memory
Digital Forms
Digital Views
Knowledge Graph
Importing and Exporting
Knowledge Extraction
Small Talk
Action & Information Task
Action Tasks
Information Tasks
Establishing Flows
Natural Language
Machine Learning
ML Model
Fundamental Meaning
NLP Settings and Guidelines
Knowledge Graph Training
Ranking and Resolver
NLP Detection
Bot Intelligence
Context Management
Session and Context Variables
Context Object
Dialog Management
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Publishing your Bot
Analyzing your Bot
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
Data Table
Universal Bots
Enabling Languages
Smart Bots
Sample Bots
Travel Planning
Flight Search
Event Based Bot Actions
koreUtil Libraries
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Bot Management
Bot Versioning
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Bot Administration
Bots Admin Console
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Inviting Users
Bulk Invites
Importing Users
Synchronizing Users from AD
Security & Compliance
Using Single Sign-On
Security Settings
Cloud Connector
How Tos
Creating a Simple Bot
Creating a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configure Digital Forms
Add Form Data into Data Tables
Configuring Digital Views
Add Data to Data Tables
Update Data in Data Tables
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
  1. Home
  2. Docs
  3. Bots
  4. Channel Enablement
  5. Adding the Unblu Channel

Adding the Unblu Channel

Unblu is a Conversational Platform for Financial Services.

To setup Unblu as a channel, you will need to create an External Integration bot in Unblu, create a ‘Named Area’ and map this Named Area to your bot.

Channel Integration

Step 1: Create a Named Area

Named Areas in Unblu are used to identify the origins of the chat requests from your website. The bot should be associated with a Named Area to ensure that it responds to users only when the chat has originated from the sections of your website associated with this Named Area. This mapping is optional if you are enabling the Unblu channel for a single bot alone. 

  1. Login to your Unblu Account Administration.
  2. Under the Named Areas module, select the ‘New named area’ option.
  3. Provide all the requested information.
  4. Make a note of the name of the Named Area you have created.

Step 2: Create Unblu Bot

A bot should be created in your Unblu account for integrating it with your current bot.

The Unblu Bot can be directly created from the Bots Platform.

  1. Create or Open the bot in the platform.
  2. From the left navigation menu, select Channels option.
  3. On the Channels page, click on Unblu to enable the same for the bot.
  4. Proceed to the Configurations tab and provide the following details for creating a bot in your Unblu account:
    • Unblu Host URL -the URL of your Unblu application. For example, use for the Unblu cloud.
    • Unblu Account UsernameProvide your Unblu account username.
    • Unblu Account Password – Provide the password associated with your Unblu username.
    • Unblu Bot Name – Provide a name you would like to use for your Unblu bot
    • Unblu Bot DescriptionProvide a short description of your Unblu bot
    • Bot Person – Provide a Name to represent the Unblu bot to your users
    • Secret Key – Provide a confidential key to secure the communication between Unblu and bots
    • Named Area – Provide the Named Area you would like to associate with your bot. will respond only to the user chats that have originated in the Named Area that you have selected here. This field is optional if you are enabling Unblu channel for a single bot alone. 
  5. Enable the channel.

Additional Instructions

For the seamless exchange of information from Unblu to, a few additional steps need to be performed:

  • The host URL where the Unblu SDK would be hosted needs to be added to the Domain section of your Unblu Account.
  • From your Unblu Account, API Keys section, make a note of the API Key.
  • Configure the Unblu SDK to give access to Bot, following the steps given below.
  • Open the Unblu SDK HTML file. Ensure that the following attributes are set:
    • In the <head> the meta tag should look thus: <meta name="unblu:named-area" content="<your-namedArea-Id>" /> This is the named area that you created in Step 1 above.
    • Script tag to populate the visitor information needs point to the Unblu host: <script src="<your-unblu-host>/unblu/js-api/v2/visitor/visitor-api.min.js"></script>
    • Invoke the function setVisitorData to pass the visitor data to bot. Note that the visitorData should be in string format and if you need to pass an object use Stringify.
      • Locate the following section and populate the apiKey and serverUrl fields with the above-mentioned values.
           apiKey: "<your-unblu-apikey>",
           serverUrl: "<your-unblu-host>"
    • In the following Script tag, add Unblu host URL and the API key: <script type="text/javascript" defer="defer" src="<your-unblu-host>/unblu/visitor.js?x-unblu-apikey=<your-unblu-apikey>"></script>
    • The entire Unblu SDK HTML file would look like this:
      <!DOCTYPE html>
         <meta name="unblu:named-area" content="<your-namedArea-Id>" />
         <script src=""></script>
         <script src="<your-unblu-host>/unblu/js-api/v2/visitor/visitor-api.min.js"></script>
         function setVisitorData(engagementType, visitorData) { 
            return Promise.resolve(JSON.stringify({ name: "John", about: "Tester" })); 
               apiKey: "<your-unblu-apikey>",
               serverUrl: "<your-unblu-host>"
            .initialize().then(function (api) {
              console.log("API initialized successfully!");
                  }).catch(e => {
                      console.log("------error : ", e);
                      if (e.type === 'INITIALIZATION_TIMEOUT') {
                       } else if (e.type === 'UNSUPPORTED_BROWSER') {
                        // display unsupported browser dialog
                      } else {
                       // show generic error message
      <script type="text/javascript" defer="defer"
    • You can access the Visitor Data from the usercontext.customData  along with the user information for each message from Unblu,
    • Following is the structure of the usercontext.customData
      "timestamp" : 1594113137065.0,
      "eventType" : "bot.dialog.opened",
      "accountId" : "wZvcAnbBSpOps9oteH-Oxw",
      "dialogToken" : "qG8dFE7ZQPW1p6qcI293hQ-c-QY7P7MNqTCuM6FHT-m-FSQ",
      "dialogType" : "ONBOARDING",
      "counterpartPerson" : {
         "type" : "PersonData",
         "id" : "xZHnVmhxQNKvyf5ybxyLoQ",
         "accountId" : "wZvcAnbBSpOps9oteH-Oxw",
         "personSource" : "VIRTUAL",
         "sourceId" : "awhFjUq1RQCvdMDoV5OW2Q",
         "sourceData" : null,
         "firstName" : null,
         "lastName" : null,
         "username" : null,
         "nickname" : null,
         "displayName" : "Visitor - xZHnV",
         "personType" : "VISITOR",
         "authorizationRole" : "ANONYMOUS_USER",
         "email" : null,
         "phone" : null,
         "teamId" : null,
         "teamName" : null,
         "avatar" : null
      "conversation" : {
         "type" : "ConversationData",
         "id" : "qG8dFE7ZQPW1p6qcI293hQ",
         "accountId" : "wZvcAnbBSpOps9oteH-Oxw",
         "topic" : null,
         "recipient" : {
         "type" : "NamedAreaData", 
         "id" : "WkUGFqcORCCor3bxHa3I5A",
         "accountId" : "wZvcAnbBSpOps9oteH-Oxw",
         "displayName" : "testlocal",
         "avatar" : null
      "participants" : [
         "type" : "ParticipantData",
         "state" : "ACTIVE",
         "personId" : "yb8ALAiGQOWlCoBahUCfgQ",
         "connectedViaExternalMessenger" : false,
         "hidden" : true
       "assigneePersonId" : null,
       "contextPersonId" : "xZHnVmhxQNKvyf5ybxyLoQ",
       "state" : "ONBOARDING",
       "initialEngagementType" : "CHAT_REQUEST",
       "locale" : "en",
       "tokboxSessionId" : null,
       "visitorData" : "{\"name\":\"John\",\"about\":\"Tester\"}",
       "conversationTemplateId" : "R6W3x2uzQ1KXzARnIqdNZw",
       "links" : [
         "type" : "OPEN_IN_VISITOR_DESK",
         "url" : ""
        "type" : "OPEN_IN_AGENT_DESK",
        "url" : ""
        "type" : "OPEN_IN_AGENT_SINGLE_VIEW",
        "url" : ""
       "externalMessengerChannelId" : null,
       "sourceId" : null,
       "configuration" : null,
       "text" : null
      "presencePersonInfo" : {
        "id" : "OuG04Q0WSFe3-iaIA1GlLw",
        "creationTimestamp" : 1594112743472.0,
        "modificationTimestamp" : 1594112743472.0,
        "accountId" : "wZvcAnbBSpOps9oteH-Oxw",
        "joinedTimestamp" : 1594112743472.0,
        "leftTimestamp" : null,
        "personId" : "xZHnVmhxQNKvyf5ybxyLoQ",
        "deviceInfo" : {
          "id" : "fx7Q8qZyQXmnf62xpoePWg",
          "creationTimestamp" : 1594112743454.0,
          "modificationTimestamp" : 1594112743454.0,
          "accountId" : "wZvcAnbBSpOps9oteH-Oxw",
          "osName" : "Ubuntu",
          "osVersion" : "Other",
          "browserName" : "Chromium",
          "browserVersion" : "81.0",
          "userAgent" : null,
          "screenWidth" : null,
          "screenHeight" : null,
          "screenPixelRatio" : null,
          "type" : "DESKTOP",
          "identifier" : "awhFjUq1RQCvdMDoV5OW2Q",
          "identifierSource" : "COOKIE",
          "pushToken" : null,
          "ownerPersonId" : "xZHnVmhxQNKvyf5ybxyLoQ"
       "touchTimestamp" : 1594113153628.0,
       "impersonationType" : "NONE",
       "impersonatedFromUserId" : null,
       "impersonatedFromAccountId" : null,
       "additionalInfo" : null,
       "authInfo" : null,
       "propagated" : false

Special Notes

There are multiple functionalities that can be achieved by the integration of Unblu channel with bots

  • When mapping named area to a bot, multiple named areas can be mapped. This way a single bot has the ability to accept Unblu dialog offer requests from different origins like SDKs or namedAreas.
  • Also, the named area mapping is optional if you are enabling the Unblu channel for a single bot. 
  • You can redirect user conversations to agents by adding an agent transfer node in the dialog flow, note that you need not enable the Agent Transfer or BotKit specifically for this Channel. Having an agent transfer node is sufficient.
  • The user information for each message from Unblu is available in the usercontext.customData and you can use it for further processing. This information includes deviceInfo, authInfo, joinedTime of the user. See here for how to use context object.

Using Unblu supported message templates

By default, the following message templates are used – Button/multi-choice, List template. You can override templates like card message, List message, multi-choice/Button message.

Following is a code example for how to use the above mentioned templates, change it to suit your requirements:

  • Card Template:
    var unbluCardTemplate = {
        "$_type": "CardPostMessageData",
        "type": "CARD",
        "imageUrl": "data:image/png;base64,",
        "imageAltText": "test image",
        "title": "Title",
        "body": "This is the **body text** with markdown",
        "bodyTextType": "MARKDOWN",
        "actions": [
            "$_type": "MessageAction",
            "actionType": "LINK_INTERNAL",
            "label": "Unblu homepage",
            "value": ""
            "$_type": "MessageAction",
            "actionType": "LINK_EXTERNAL",
            "label": "Wikipedia",
            "value": ""
            "$_type": "MessageAction",
            "actionType": "REPLY_MESSAGE",
            "label": "More info",
            "value": "Could you provide me with more info?"
  • List Template:
    var unbluListTemplate = {
        "$_type": "ListPostMessageData",
        "type": "LIST",
        "header": {
          "$_type": "MessageHeader",
          "imageUrl": "data:image/png;base64,",
          "imageAltText": "test image",
          "title": "Title",
          "body": "This is the **body text** with markdown",
          "bodyTextType": "MARKDOWN"
        "items": [
            "$_type": "PostListMessageCardItemData",
            "imageUrl": "data:image/png;base64,",
            "imageAltText": "test image",
            "title": "Title",
            "body": "This is the **body text** with markdown",
            "bodyTextType": "MARKDOWN",
            "action": null
            "$_type": "PostListMessageCardItemData",
            "imageUrl": "data:image/png;base64,",
            "imageAltText": "test image",
            "title": "Title",
            "body": "This is the **body text** with markdown",
            "bodyTextType": "MARKDOWN",
            "action": {
              "$_type": "MessageAction",
              "actionType": "LINK_INTERNAL",
              "label": "Unblu homepage",
              "value": ""
        "actions": [
            "$_type": "MessageAction",
            "actionType": "LINK_INTERNAL",
            "label": "Unblu homepage",
            "value": ""
            "$_type": "MessageAction",
            "actionType": "LINK_EXTERNAL",
            "label": "Wikipedia",
            "value": ""
            "$_type": "MessageAction",
            "actionType": "REPLY_MESSAGE",
            "label": "More info",
            "value": "Could you provide me with more info?"
  • Multi Choice Template:
    var unbluMultiChoiceTemplate =  {
        "$_type": "MultichoiceQuestionPostMessageData",
        "type": "MULTICHOICE_QUESTION",
        "text": "Choose one of the options",
        "textType": "MARKDOWN",
        "options": [
            "$_type": "MultichoiceQuestionOption",
            "label": "Option 1",
            "value": "1",
            "primary": true
            "$_type": "MultichoiceQuestionOption",
            "label": "Option 2",
            "value": "2",
            "primary": false

Editing the Unblu Channel

To edit the Unblu channel, hover your mouse over the channel to modify, and then click the Settings icon to display the command menu . Select one of the following commands to modify the channel:

  • Disable/Enable – Click Disable to temporarily disable the use of the Unblu for your Bot. To enable the use of the Unblu channel, Click Enable.
  • Delete – Click Delete, and then click OK in the Delete Confirmation dialog to permanently delete the Bot channel configuration.
Warning: This operation is permanent, and cannot be undone.