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
User Prompts
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
Advanced NLP Configurations
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
Manage Sessions
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. SDKs
  5. BotKit SDK Tutorial – Blue Prism

BotKit SDK Tutorial – Blue Prism

The integration of bots with Blue Prism helps you drive business process automation using conversational flows. bots execute conversation flows by understanding user intents, entities, context, and sentiment. Blue Prism RPA services can consume the contextually relevant information and effectively automate business processes.

Integration Approach’s Blue Prism Connector is a generic reference integration for connecting bots with your enterprise Blue Prism RPA services. Conversation flow can be defined to invoke RPA services using Webhook nodes via BotKit SDK integration. The following is a typical integration flow:

  • Conversation flows in bots can be configured to pass the contextually relevant information like intent in progress, entities collected, etc. to the BotKit SDK (platform extension)
  • BotKit SDK can be used to invoke the RPA process using the Blue Prism Connector.
  • The connector invokes the specified RPA process on Blue Prism and returns the response back to the platform.
  • Response from RPA service can be used in defining bot definitions like dialog transitions, entity determination, end-user responses, etc..


Before you begin, ensure that you have completed the following necessary steps:

  • Signup for Blue Prism’s RPA platform and define your automation flows.
  • Download BotKit SDK from here,  review and update integration details of your Blue Prism instance in the BluePrismConnector.js file.
  • Enable RPA services on the Blue Prism platform to start communicating with your bots.

Steps in Integration

Following are the steps in integrating Blue Prism with your bot:

  • Step 1: Create a Dialog task and build flow to meet your business use case
  • Step 2: Identify the specific locations in your flow that require integration with Blue Prism to invoke RPA services
  • Step 3: Build your RPA service request JSON object (BluePrismRequest) using Script nodes (refer here for how). Refer to the ‘Sample Request Object‘ section given below for a sample representation.
  • Step 4: Place Webhook nodes in the identified locations. Ensure that you have setup BotKit SDK and configured the connections. Refer here for more details on Webhook Node.
  • Step 5: Review the request payload that the platform passes to BotKit for invoking the RPA service.
  • Step 6: Response payload (BluePrismResponse) received from RPA services is now available in the dialog context. You can use the data from the BluePrismResponse object to compose a response to the user or define conversation flows of your bot.

Sample Request Object

The information required for invoking the RPA services has to be populated following the structure provided in this section. On reaching the Webhook node in the conversation, the information required for invoking the RPA services is forwarded to the BotKit by the platform which in turn would make the call to the RPA service.

The request payload should include the following information.

 var bluePrismRequest = {};

  bluePrismRequest= {
     "url" : "<service endpoint for process>",
     "operation" : "<RPA Process Name>",
          UserInput1 :"<input1>",
          UserInput2 : "<input2>",
Parameter Type Description
operation String Name of the RPA Process created
url URL Service endpoint of the RPA process
attributes Blue Prism supported Data Types Data inputs needed to run the RPA Process

Responses from Blue Prism

Response from Blue Prism services is received by the BotKit SDK and then it is passed on to your bot’s dialog task. The response is stored in the context object against the predefined key ‘ResponseFromBluePrism. You may configure Blue Prism services to respond either in ‘sync‘ or ‘async‘ modes. In the case of ‘async’ mode, your Blue Prism services should call the following URL to post the response: http://<host>/sdk/blueprismConnector/:<requestId>

  • <host> refers to the environment of your bots. Example:
  • <requestId> refers to the unique reference number associated with the request made to the Blue Prism service from your bots

Post processing the Webhook node, the platform will resume the task from that point forward and the dialog will be executed as per the regular conversation flow. As the Blue Prism response is present in the dialog’s context, you may use it for defining conversation flows, customizing responses to the end users, etc.