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. Using the BotKit SDK

Using the BotKit SDK

The BotKit SDK is a set of libraries that provide you with precision control for bot interaction with users for the bots you build on Bots Platform.

When you build a dialog task using Dialog Editor in Bot Builder, you can subscribe message and webhook events by adding event handlers and controlling the messages and webhook events using the SDK.

This topic describes how the BotKit SDK is integrated with the Bots Platform, the SDK events you can use, and download and installation instructions for the BotKit SDK.

While bots can be built to help answer user queries and to perform a transaction for a user, in some cases, we may still need to switch from a bot interaction to a human agent to help the user complete the intent.

For example:

  • A user asks a question or provides a response that the bot is not designed to answer.
  • A user directly requests to chat with Live Agent rather than that bot itself.
  • As a bot developer, you design a Live Agent transfer based on the dialog flow based on a specific condition. For example, a specific user type, or based on tone analysis of the user, you want the dialog flow to transfer to a Live Agent.

How it Works

You can integrate event handling using the BotKit SDK in your Dialog task by capturing the following event types on the Bots Platform.


On the Bots Platform, a user interacts with your bot on one of the channels defined for the Bot. In the following diagram, you can see the user message flow through the Bots Platform, the BotKit SDK, and our natural language processing engine.

All messages, both user and Bot responses are sent to the BotKit SDK as message events.


Your BotKit SDK receives webhook events whenever the natural language processor enters the SDKWebhook node in a Bot Builder dialog task flow. In the following sequence diagram, flow for a user sending a message via a bot channel until the user response is shown.

For webhook events, you should add a Webhook node in the dialog task flow whenever there is a need for server-side validation, execution of business logic, or a backend server call is required. Business logic and the response is sent on the same on_webhook event. The response is an HTTP status code 202. To send response data to the Bots Platform from the SDK, call the sdk.sendWebhookResponse() event.
Webhook events are received by the SDK when the NL Engine processes a Webhook node in a dialog task flow. The NLP engine processes each node, and then transitions to the next node based on the conditions defined. When a Webhook node is processed, a webhook call is executed and the Bots Platform sends the on_webhook event to the SDK. The following sequence diagram shows the message flow with a webhook.

Agent Transfer

In the following sequence diagram, the Bots Platform responds to user input directly, until the Agent Transfer condition is matched. When matched, the Bots Platform connects to your BotKit SDK implementation, and then initializes the chat, for example, getting the current conversation. The BotKit SDK integrates the user and agent conversation until the Live Agent session is closed. When switching to a Live Agent, the current dialog task ends.

To set up an Agent Transfer in your dialog conversation flow, you will need to:

  1. Create an app in Bot Builder on the Settings tab > SDK Configurations section, define the Callback URL and generate Client ID and Client Secret, and enable OnAgentTransferNode.
  2. Identify the steps and define the transition conditions to meet to transfer to an agent.
  3. Add the Agent Transfer node in the dialog flow as shown in the following illustration

For more information, see BotKit SDK Tutorial – Agent Transfer.