HipChat Channel for Microsoft Bot Framework

This project serves as an example of how one can build a HipChat Connect add-on for Microsoft Bot Framework bots using Atlassian-Connect-Express and DirectLine.

What

The Microsoft Bot Framework natively supports a set of channels out of the box. In order to support your own channel, you'll need to use the Direct Line API to expose your bots to the channel. This HipChat Channel for the Microsoft Bot Framework is a demonstration of how to implement your own channel support.

Installation

1. Git Clone

   $ git clone [this_git_repo]
   $ cd botframework-hipchatchannel
   

2. Setup ngrok to develop locally (see this for more info).

   $ ngrok http 3000
   

   Update the localBaseUrl variable in config.json with the HTTPS address of your ngrok instance

3. Configure the Direct Line secret for your Microsoft Bot Framework bot

   $ export DIRECT_LINE_SECRET=[your_direct_line_secret]
   

   Assuming you already have a bot running using the Microsoft Bot Framework, the Direct Line Secret can be obtained through the Bot Framework developer portal in the channels list. Ensure that v3.0 is enabled.

4. Start Redis

   $ redis-server
   

5. Start the app

   $ npm install
   $ node app.js
   

Usage

1. Deploy your bot created using the Microsoft Bot Framework You can use the sample bot included in this project.

2. Get the Direct Line Secret from the Bot Framework developer portal and configure the DIRECT_LINE_SECRET env variable

3. From a browser, navigate to the HTTPS address of your ngrok instance

   

4. Install the connector to a room in your HipChat instance. See this for further details.

5. Start chatting with the bot

   

6. Here are examples of some of the basic cards from Bot Framework:

   Hero card

   

   Thumbnail card

   

   Receipt card

   

   Signin card