{"id":15524410,"url":"https://github.com/codeforequity-at/botium-connector-landbot","last_synced_at":"2025-09-09T21:33:53.223Z","repository":{"id":91176447,"uuid":"313584256","full_name":"codeforequity-at/botium-connector-landbot","owner":"codeforequity-at","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-28T11:18:35.000Z","size":294,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T20:16:37.664Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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}},"created_at":"2020-11-17T10:30:07.000Z","updated_at":"2025-01-16T09:24:25.000Z","dependencies_parsed_at":"2025-02-03T06:34:39.395Z","dependency_job_id":"783748f1-41fb-4713-8c67-2029f4cff063","html_url":"https://github.com/codeforequity-at/botium-connector-landbot","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.25,"last_synced_commit":"fc1b2c9b2684d03fc696441974fd414fd347de32"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/codeforequity-at/botium-connector-landbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-landbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-landbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-landbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-landbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-landbot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-landbot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274366442,"owners_count":25272294,"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","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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:12.384Z","updated_at":"2025-09-09T21:33:53.199Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Landbot\n\n[![NPM](https://nodei.co/npm/botium-connector-landbot.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-landbot/)\n\n[![Codeship Status for codeforequity-at/botium-connector-landbot](https://app.codeship.com/projects/ac5ab3a0-d0f5-0138-cac3-16239a5027f5/status?branch=master)](https://app.codeship.com/projects/408148)\n[![npm version](https://badge.fury.io/js/botium-connector-landbot.svg)](https://badge.fury.io/js/botium-connector-landbot)\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 [Landbot API chatbot](https://app.landbot.io/).\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 connects to the API of your Landbot chatbot.\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 **Landbot API bot**\n* a **project directory** on your workstation to hold test cases and Botium configuration\n\n## Install Botium and Landbot Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-landbot\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-landbot\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 Landbot chatbot to Botium\n\nProcess is very simple, you have to know just the Auth token of your Landbot API channel.\n  \nCreate a botium.json with this Auth token in your project directory: \n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"landbot\",\n      \"LANDBOT_TOKEN\": \"...\"\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://botium.atlassian.net/wiki/spaces/BOTIUM/pages/491664/Botium+Scripting+-+BotiumScript) files.\n\n## How to start samples\n\nThere is a small demo in [samples](./samples) with Botium Bindings. It uses real Landbot API chatbot.\n\n### Real Landbot API chatbot sample\n\n* Setup your Landbot API chatbot in [Landbot app](https://app.landbot.io/). Create a new Landbot API chatbot.\nModify the basic template according to this screen:\n\n![Real example](https://github.com/codeforequity-at/botium-connector-landbot/blob/master/samples/real/real-example.png?raw=true)\n  \n* Install the dependencies and botium-core as peerDependency:\n    ```\n    \u003e npm install \u0026\u0026 npm install --no-save botium-core\n    ```\n* Navigate into the _samples/real_ directory\n    * Install the dependencies\n        ```\n        \u003e cd ./samples/real\n        \u003e npm install\n        ```\n    * Adapt botium.json in the sample directory: \n        * Change Landbot token\n        \n    * Start `inbound-proxy` (it will listen on `http://127.0.0.1:45100/`):\n         ```\n         \u003e npm run inbound\n         ```\n    * In your Landbot channel you need to set `HOOK URL(S)` according to the previous step set up inbound-proxy url. \n    (To make this localhost url public you can use e.g. [ngrok](https://ngrok.com/))\n    * Finally run the test\n        ```\n        \u003e  npm test\n        ```\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __landbot__ to activate this connector.\n\n### LANDBOT_TOKEN\nLandbot channel `AUTH TOKEN` field\n\n### LANDBOT_API_TOKEN\nThis capability is need only if nlp data has to be processed as well e.g. for using it with [botium-coach](https://www.botium.ai/coach/). \nIn this case you can find your API token under you landbot app account.\n\n_Info: You need have a [dialogflow integration](https://help.landbot.io/article/j6n7arejz4-integrations-dialogflow-block) in you Landbot API chatbot,\nand in dialogflow configuration the Query Response has to be set._\n\n### LANDBOT_QUERY_RESULT\nThe value of this capability is `query_result` by default. \nThe same value has to be set here as in the Query Response field in your dialogflow integration.\n\n_If you don't set LANDBOT_API_TOKEN, this capability is ignored._ \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-landbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-landbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-landbot/lists"}