{"id":15524390,"url":"https://github.com/codeforequity-at/botium-connector-chatlayer","last_synced_at":"2026-02-17T16:01:11.876Z","repository":{"id":48981762,"uuid":"222475319","full_name":"codeforequity-at/botium-connector-chatlayer","owner":"codeforequity-at","description":"Botium Connector for Chatlayer.ai","archived":false,"fork":false,"pushed_at":"2025-01-28T11:20:39.000Z","size":45,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T20:16:36.518Z","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-11-18T14:59:37.000Z","updated_at":"2025-01-16T09:42:00.000Z","dependencies_parsed_at":"2025-02-03T06:34:39.278Z","dependency_job_id":"297317c8-a4a4-4b39-878b-b1152aec3b85","html_url":"https://github.com/codeforequity-at/botium-connector-chatlayer","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/codeforequity-at/botium-connector-chatlayer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-chatlayer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-chatlayer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-chatlayer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-chatlayer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-chatlayer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-chatlayer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29549205,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T14:33:00.708Z","status":"ssl_error","status_checked_at":"2026-02-17T14:32:58.657Z","response_time":100,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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:08.462Z","updated_at":"2026-02-17T16:01:11.854Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Chatlayer.ai\n\n[![NPM](https://nodei.co/npm/botium-connector-chatlayer.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-chatlayer/)\n\n[![Codeship Status for codeforequity-at/botium-connector-chatlayer](https://app.codeship.com/projects/272f0fc0-ec43-0137-f319-7ae2d5dde536/status?branch=master)](https://app.codeship.com/projects/374593)\n[![npm version](https://badge.fury.io/js/botium-connector-chatlayer.svg)](https://badge.fury.io/js/botium-connector-chatlayer)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()\n\n\nThis is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your [Chatlayer.ai](https://www.chatlayer.ai/) 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\nBotium automatically starts a webhook and connects to the [Chatlayer.ai REST API](https://docs.chatlayer.ai/channels/webhook-api) to receive chatbot responses.\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## Requirements\n* **Node.js and NPM**\n* a **Chatlayer.ai bot**\n* a **project directory** on your workstation to hold test cases and Botium configuration\n\n## Install Botium and Chatlayer.ai Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-chatlayer\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-chatlayer\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 Chatlayer.ai chatbot to Botium\n\nChatlayer.ai has an asynchronous communication model: the bot response is not part of the HTTP/JSON response, but it is sent to a webhook. This webhook is started automatically by Botium, and it has to be registered in Chatlayer first. You have to take care that this webhook is available from the public internet.\n\n#### Confiure the webhook\n\nThere are two possibilities to set up the webhook endpoint.\n\n###### Proxy server\nConfigure the webhook with the capabilities _SIMPLEREST_INBOUND_PORT_ and _SIMPLEREST_INBOUND_ENDPOINT_. When starting Botium, the webhook is available at _http://local-ip-address:inbound-port/input-endpoint_. If your workstation is not available from public internet, you can use a service like [ngrok](https://ngrok.com/) to make it public:\n\n    \u003e ngrok http 1234\n\nThe webhook is available at _https://something.ngrok.io/input-endpoint_ then.\n\n###### Proxy server with redis\nConfigure the webhook with the capability SIMPLEREST_INBOUND_REDISURL. Then start and inbound proxy with `botium-cli`. \n\n    \u003e botium-cli inbound-proxy\n    \n     redis://127.0.0.1:6379\n     Botium Inbound Messages proxy is listening on port 45100\n     Botium Inbound Messages endpoint available at http://127.0.0.1:45100/\n\nTo make it public you can use ngrok:\n    \n    \u003e ngrok http 45100\n\nThe webhook is available at https://something.ngrok.io then.\n\nIf your proxy server is up and running, then you can register the webhook URL together with a verify token of your choice at [Chatlayer.ai](https://docs.chatlayer.ai/channels/webhook-api).\n\nCreate a botium.json in your project directory: \n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"chatlayer\",\n      \"CHATLAYER_URL\": \"...\"\n      \"CHATLAYER_VERIFY_TOKEN\": \"...\",\n      \"CHATLAYER_ACCESS_TOKEN\": \"...\",\n      \"SIMPLEREST_INBOUND_REDISURL\": \"redis://127.0.0.1:6379\"\n    }\n  }\n}\n```\n\nTo check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:\n\n```\n\u003e botium-cli emulator\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## How to start samples\n\n* Adapt botium.json in the `sample/simple` directory\n* Install packages, start inbound proxy and run the test.\n\n_In this sample we use the webhook configuration which is written under **Proxy server with redis**_\n```\n\u003e cd ./samples/simple\n\u003e npm install\n\u003e npm run inbound\n\u003e npm test\n```\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __chatlayer__ to activate this connector.\n\n### CHATLAYER_URL*\nChatlayer API url\n\n### CHATLAYER_CHANNEL_ID *\nChatlayer Channel Identifier. You can find this information in the `Configure Webhook` dialog on chatlayer surface.\n\n### CHATLAYER_VERIFYTOKEN *\nChatlayer Webhook verify token.\n\n### CHATLAYER_ACCESS_TOKEN *\nYou generate one under the `Tokens` menu on chatlayer surface.\n\n### CHATLAYER_SESSION_DATA\nOptionally you can set session data as a json object.\n\n### CHATLAYER_WELCOME_MESSAGE\nSet it true if your bot has welcome/intro message.\n\n### CHATLAYER_BOT_ID\nFor detailed nlp data the bot id has to be set up. You can copy this from the url of your chatbot on chatlayer surface.\nE.g. my url is 'https://app.chatlayer.ai/bots/abcdabcd/DRAFT' then the bot id is: `abcdabcd`\n\n### CHATLAYER_VERSION\nSet which version you use. It can be `DRAFT` of `LIVE`. The default value is `DRAFT`.\n\n### CHATLAYER_LANGUAGE\nThe language of your chatbot. The default value is `en`.\n\n\n### SIMPLEREST_INBOUND_PORT\n\n### SIMPLEREST_INBOUND_ENDPOINT\ne.g. `/chatlayer`\n\n### SIMPLEREST_INBOUND_REDISURL\ne.g. `redis://127.0.0.1:6379`\n\n### Roadmap\n* Support for entity asserter\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-chatlayer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-chatlayer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-chatlayer/lists"}