# botium-connector-botkit

> Botium Connector for Botkit

Latest version **0.0.7** (published 2026-03-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install botium-connector-botkit
pnpm add botium-connector-botkit
yarn add botium-connector-botkit
bun add botium-connector-botkit
```

## Health

**Score 50/100 (C)** — status: active.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2026-03-18 |
| First published | 2019-01-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 280 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Botium GmbH |
| Maintainers | ftreml |

## Links

- npm: https://www.npmjs.com/package/botium-connector-botkit
- Repository: https://github.com/codeforequity-at/botium-connector-botkit
- Homepage: https://github.com/codeforequity-at/botium-core
- Issues: https://github.com/codeforequity-at/botium-core/issues
- npm.io page: https://npm.io/package/botium-connector-botkit

## Dependencies (4)

- [uuid](https://npm.io/package/uuid.md) ^3.3.3
- [debug](https://npm.io/package/debug.md) ^4.4.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.23
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.15.4

## Recent versions

- 0.0.7 (latest) — 2026-03-18
- 0.0.5 — 2019-12-09
- 0.0.4 — 2019-07-25
- 0.0.3 — 2019-01-10
- 0.0.2 — 2019-01-10
- 0.0.1 — 2019-01-07

## README

# Botium Connector for Botkit 
[![npm version](https://badge.fury.io/js/botium-connector-botkit.svg)](https://badge.fury.io/js/botium-connector-botkit)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()

This is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your Botkit chatbot.

__Did you read the [Botium in a Nutshell](https://medium.com/@floriantreml/botium-in-a-nutshell-part-1-overview-f8d0ceaf8fb4) articles ? Be warned, without prior knowledge of Botium you won't be able to properly use this library!__

## How it works?

This connector calls the webhook URL of botkit. 

This webhook can be there even if your chatbot uses Websocket. You can set it in Botkit constructor:
```
const controller = new Botkit({
  webhook_uri: '/api/messages',
  ...
})
```

There was a major change in Botkit. Botkit Anywhere is deprecated, and core lib version is changed from 0.7 to 4.0. 
Botium supports officially __Botkit Core version 0.7 with Botkit Anywhere__ or 
__Botkit Core version 4.0 with Botkit App created by [Yeoman generator](https://www.npmjs.com/package/generator-botkit)__,
but may work with __Botkit Core version 4.0 with Botkit Anywhere__. 

You can set your Botkit environment using __BOTKIT_VERSION__ capability.

__Botium Botkit Connector 0.0.3 and below works just with the old Botkit stack!!!__

It can be used as any other Botium connector with all Botium Stack components:
* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)
* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)
* [Botium Box](https://www.botium.at)


## Requirements

* __Node.js and NPM__
* a __Botkit Anywhere Server__, or __Botkit server created by Yeoman generator__
* a __project directory__ on your workstation to hold test cases and Botium configuration

## Install Botium and Botkit Connector

When using __Botium CLI__:

```
> npm install -g botium-cli
> npm install -g botium-connector-botkit
> botium-cli init
> botium-cli run
```

When using __Botium Bindings__:

```
> npm install -g botium-bindings
> npm install -g botium-connector-botkit
> botium-bindings init mocha
> npm install && npm run mocha
```

When using __Botium Box__:

_Already integrated into Botium Box, no setup required_

## Connecting your Botkit server to Botium

Open the file _botium.json_ in your working directory and add the Botkit chatbot connection settings.

```
{
  "botium": {
    "Capabilities": {
      "PROJECTNAME": "<whatever>",
      "CONTAINERMODE": "botkit",
      "BOTKIT_VERSION": "BOTKIT_4_0",
      "BOTKIT_URL": "..."
    }
  }
}
```
Botium setup is ready, you can begin to write your [BotiumScript](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.

## Supported Capabilities

Set the capability __CONTAINERMODE__ to __botkit__ to activate this connector.

### BOTKIT_VERSION
Default: 

```ANYWHERE_AND_BOTKIT_0_7_AND_BELOW```

Botkit stack. Set it to ```BOTKIT_4_0``` to use the new. 
The two versions are using different capabilities, see below. 

### BOTKIT_4_0_SERVER_URL
__Just for new Botkit stack!!!__

Botkit server webhook URL. The only required capability using the new stack

### BOTKIT_4_0_...
Just for new Botkit stack!!!

You can use all other _Generic HTTP(S)/JSON Connector_ capabilities. 
For example via __BOTKIT_4_0_HEADERS_TEMPLATE__ you can use __SIMPLEREST_HEADERS_TEMPLATE__ capability to customize the HTTP header.

There is a [sample](./samples/botkit40/test) using the [UPDATE_CUSTOM logic hook](https://botium.atlassian.net/wiki/spaces/BOTIUM/pages/48660497/Integrated+Logic+Hooks) and the __BOTKIT_4_0_BODY_TEMPLATE__ capability to use custom user ids.

### BOTKIT_SERVER_URL
__Just for old Botkit stack!!!__

The Botkit server url (without any path, just http/https, servername, port)

### BOTKIT_USERID
__Just for old Botkit stack!!!__

If set, this userId will be used. Otherwise, for each convo a new userId is generated.

---
_Source: https://npm.io/package/botium-connector-botkit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._