Installing the BotKit SDK

The BotKit SDK runs as Node.js application. You can add your own reverse proxy, firewall, and load balancer to meet your functional requirements for availability, scalability and performance.

This section provides a high-level overview of BotKit SDK installation and configuration. For a detailed end-to-end tutorial on installation and setup using our Sample Bots, see the BotKit SDK Tutorial.

To install the BotKit SDK, you will need to:

  • Register your application on the Bots Platform by creating a bot, and then configuring that bot for the Web/Mobile channel.
  • Download and deploy the BotKit SDK libraries.
  • Configure the config.json file.


As a prerequisite for BotKit SDK installation, you need to register your SDK app with the Bots Platform using the Bot Builder tool. In Bot Builder you need to create a bot, and then add the Web/Mobile channel to that bot to generate the ClientID and Client Secret security credentials used for mutual SSL authentication for communication between your app and the Bots Platform and to authorize API calls from your SDK to the Bots Platform. 

In the config.json file in the SDK, you will need to copy the following authentication keys from the SDK Configuration section for your bot in Bot Builder.

  • appId = ClientID
  • appKey – Client Secret

For more information, see SDK App Registration.

Installation and Setup

The BotKit SDK libraries can be downloaded from the Github repository at:

To configure your SDK, you need to define the following keys in your config.json file to get your BotKit up and running.

[table id=214 /Starting the BotKit SDK

To run BotKit SDK, in a Terminal window, enter:

node app.js

For more information, see the BotKit SDK Tutorial – Flight Search Sample Bot.

Was this article helpful to you? Yes 39 No 1