{"id":15524371,"url":"https://github.com/codeforequity-at/botium-connector-botkit","last_synced_at":"2025-04-14T22:23:28.263Z","repository":{"id":37885500,"uuid":"164448772","full_name":"codeforequity-at/botium-connector-botkit","owner":"codeforequity-at","description":"Botium Connector for Botkit","archived":false,"fork":false,"pushed_at":"2024-12-12T14:06:46.000Z","size":366,"stargazers_count":2,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T10:21:28.632Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.botium.at","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeforequity-at.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-07T15:00:10.000Z","updated_at":"2024-12-12T14:06:50.000Z","dependencies_parsed_at":"2023-02-02T20:46:19.407Z","dependency_job_id":null,"html_url":"https://github.com/codeforequity-at/botium-connector-botkit","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-botkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-botkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-botkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-botkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-botkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248969775,"owners_count":21191324,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T10:51:06.306Z","updated_at":"2025-04-14T22:23:28.242Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Botkit \n[![npm version](https://badge.fury.io/js/botium-connector-botkit.svg)](https://badge.fury.io/js/botium-connector-botkit)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()\n\nThis is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your Botkit chatbot.\n\n__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!__\n\n## How it works?\n\nThis connector calls the webhook URL of botkit. \n\nThis webhook can be there even if your chatbot uses Websocket. You can set it in Botkit constructor:\n```\nconst controller = new Botkit({\n  webhook_uri: '/api/messages',\n  ...\n})\n```\n\nThere was a major change in Botkit. Botkit Anywhere is deprecated, and core lib version is changed from 0.7 to 4.0. \nBotium supports officially __Botkit Core version 0.7 with Botkit Anywhere__ or \n__Botkit Core version 4.0 with Botkit App created by [Yeoman generator](https://www.npmjs.com/package/generator-botkit)__,\nbut may work with __Botkit Core version 4.0 with Botkit Anywhere__. \n\nYou can set your Botkit environment using __BOTKIT_VERSION__ capability.\n\n__Botium Botkit Connector 0.0.3 and below works just with the old Botkit stack!!!__\n\nIt can be used as any other Botium connector with all Botium Stack components:\n* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)\n* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)\n* [Botium Box](https://www.botium.at)\n\n\n## Requirements\n\n* __Node.js and NPM__\n* a __Botkit Anywhere Server__, or __Botkit server created by Yeoman generator__\n* a __project directory__ on your workstation to hold test cases and Botium configuration\n\n## Install Botium and Botkit Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-botkit\n\u003e botium-cli init\n\u003e botium-cli run\n```\n\nWhen using __Botium Bindings__:\n\n```\n\u003e npm install -g botium-bindings\n\u003e npm install -g botium-connector-botkit\n\u003e botium-bindings init mocha\n\u003e npm install \u0026\u0026 npm run mocha\n```\n\nWhen using __Botium Box__:\n\n_Already integrated into Botium Box, no setup required_\n\n## Connecting your Botkit server to Botium\n\nOpen the file _botium.json_ in your working directory and add the Botkit chatbot connection settings.\n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"botkit\",\n      \"BOTKIT_VERSION\": \"BOTKIT_4_0\",\n      \"BOTKIT_URL\": \"...\"\n    }\n  }\n}\n```\nBotium setup is ready, you can begin to write your [BotiumScript](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __botkit__ to activate this connector.\n\n### BOTKIT_VERSION\nDefault: \n\n```ANYWHERE_AND_BOTKIT_0_7_AND_BELOW```\n\nBotkit stack. Set it to ```BOTKIT_4_0``` to use the new. \nThe two versions are using different capabilities, see below. \n\n### BOTKIT_4_0_SERVER_URL\n__Just for new Botkit stack!!!__\n\nBotkit server webhook URL. The only required capability using the new stack\n\n### BOTKIT_4_0_...\nJust for new Botkit stack!!!\n\nYou can use all other _Generic HTTP(S)/JSON Connector_ capabilities. \nFor example via __BOTKIT_4_0_HEADERS_TEMPLATE__ you can use __SIMPLEREST_HEADERS_TEMPLATE__ capability to customize the HTTP header.\n\nThere 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.\n\n### BOTKIT_SERVER_URL\n__Just for old Botkit stack!!!__\n\nThe Botkit server url (without any path, just http/https, servername, port)\n\n### BOTKIT_USERID\n__Just for old Botkit stack!!!__\n\nIf set, this userId will be used. Otherwise, for each convo a new userId is generated.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-botkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-botkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-botkit/lists"}