appless-botkit-adapter

Connect Botkit or BotBuilder to AppLess.

This package contains an adapter that communicates directly with the AppLess API, and translates messages to and from a standard format used by your bot. This package can be used alongside your favorite bot development framework to build bots that work with AppLess.

Install Package

Add this package to your project using npm:

npm install --save appless-botkit-adapter

Import the adapter class into your code:

const { AppLessAdapter } = require("appless-botkit-adapter");

Get Started

If you are starting a brand new project, follow these instructions to create a customized application template.

Use AppLessAdapter in your App

AppLessAdapter provides a translation layer for Botkit and BotBuilder so that bot developers can connect to AppLess and have access to the AppLess's API.

Botkit Basics

When used in concert with Botkit, developers need only pass the configured adapter to the Botkit constructor, as seen below. Botkit will automatically connect to AppLess's API in order to receive messages and events.

Developers can then bind to Botkit's event emitting system using controller.on and controller.hears to filter and handle incoming events from the messaging platform. Learn more about Botkit's core feature →.

const adapter = new AppLessAdapter({
    auth_token: process.env.APPLESS_API_HEADER_AUTH_KEY,
    api_host: process.env.APPLESS_API_URL,
});

const controller = new Botkit({
    adapter,
    // ...other options
});

controller.on("message", async (bot, message) => {
    await bot.reply(message, "I heard a message!");
});

BotBuilder Basics

Alternately, developers may choose to use AppLessAdapter with BotBuilder. With BotBuilder, the adapter is used more directly with a webserver, and all incoming events are handled as Activities.

const adapter = new AppLessAdapter({
    auth_token: process.env.APPLESS_API_HEADER_AUTH_KEY,
    api_host: process.env.APPLESS_API_URL,
});

// Create HTTP server.
let server = restify.createServer();
server.listen(process.env.port || process.env.PORT || 3000, function () {
    console.log(`\n${server.name} listening to ${server.url}`);
});

// Listen for incoming requests at /api/messages.
server.use(restify.plugins.bodyParser());
server.post("/api/messages", (req, res) => {
    // Use the adapter to process the incoming web request into a TurnContext object.
    adapter.processActivity(req, res, async (turnContext) => {
        // Do something with this incoming activity!
        if (turnContext.activity.type === "message") {
            // Get the user's text
            const utterance = turnContext.activity.text;
            // send a reply
            await turnContext.sendActivity(`I heard you say ${utterance}`);
        }
    });
});

Event List

Botkit will emit the following events:

| Event | Description | | ------- | -------------------------------------------------- | | message | a message from a user received in a shared channel |

About Botkit

Botkit is a part of the Microsoft Bot Framework.

Botkit is released under the MIT Open Source license