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. SDK Configuration

SDK Configuration

To enable your Bot to communicate between your application servers and servers, you need to create and register an app in Bot Builder that specifies the callback URL for your application, and generates the Client ID and Client Secret authentication tokens required for secure communications between your application and any Bots in your developer account.

This topic describes how to create an app and generate registration credentials when using the SDK.

To access webhooks and messages in Dialog tasks, you need to subscribe to an app for your bot. All messages from the bot and user are sent to the SDK as message events. When a Webhook node is defined in a Dialog task, the webhook event is sent to the SDK at runtime. You must install, host, and configure the SDK in your network to allow communications between the bot event messages and webhooks, and your application.

To create an app

  1. Hover over the side-navigation panel of the bot, and click API Extensions. The BotKit SDK tab opens by default.
  2. On the BotKit SDK page, click the Add button next to the App Name drop-down list. The Create App dialog opens.
  3. In the App Name field, enter the name of the app registration, for example, SDK App, and then click Next.
  4. The Client ID and Client Secret are generated along with the App Created Successfully message.
  5. Click Done. The following fields appear.
  6. In the Callback URL field displayed, enter the URL for your application that you want to push data to, for example,
  7. In the Events section, select one or more of:
    • OnMessage – Triggers an event when a message from a user is received.
    • OnHookNode – Triggers an event when a WebHook node is encountered in the Dialog task flow.
    • onEvent – Triggers an event every time a Dialog or FAQ is finished.
    • onAlert – Triggers an event when the user receives an alert message.
    • onVariableUpdate – Triggers an event when the bot is published
  8. Click Create Credentials.

The new app registration along with credentials is displayed in the SDK Configuration section.