{"id":15524352,"url":"https://github.com/codeforequity-at/botium-connector-whatsapp","last_synced_at":"2025-04-23T07:31:31.930Z","repository":{"id":57190207,"uuid":"213696797","full_name":"codeforequity-at/botium-connector-whatsapp","owner":"codeforequity-at","description":"Botium Connector for Whatsapp Webhooks","archived":false,"fork":false,"pushed_at":"2020-09-16T15:08:38.000Z","size":20,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-26T09:05:59.808Z","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-10-08T16:34:58.000Z","updated_at":"2023-10-16T13:52:04.000Z","dependencies_parsed_at":"2022-08-27T10:41:39.523Z","dependency_job_id":null,"html_url":"https://github.com/codeforequity-at/botium-connector-whatsapp","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-whatsapp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-whatsapp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-whatsapp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-whatsapp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-whatsapp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250391191,"owners_count":21422855,"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:03.587Z","updated_at":"2025-04-23T07:31:31.908Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Whatsapp Webhooks\n\n[![NPM](https://nodei.co/npm/botium-connector-whatsapp.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-whatsapp/)\n\n[![Codeship Status for codeforequity-at/botium-connector-whatsapp](https://app.codeship.com/projects/3bfbdb70-cc38-0137-cfbb-56d5361bfa83/status?branch=master)](https://app.codeship.com/projects/368328)\n[![npm version](https://badge.fury.io/js/botium-connector-whatsapp.svg)](https://badge.fury.io/js/botium-connector-whatsapp)\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 [Whatsapp Business API Webhooks](https://developers.facebook.com/docs/whatsapp/api/webhooks).\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 emulates the [Whatsapp Business API](https://developers.facebook.com/docs/whatsapp)\n* It sends inbound messages to your webhook\n* It listens for outbound messages from your webhook\n\n__Redis__ is used to connect the webhook to Botium scripts: all messages received over the webhook are published to Redis, and Botium on the other end subscribes to those Redis channels before running a conversation. \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\n* __Node.js and NPM__\n* a __Whatsapp Business API Webhook__\n* a __Redis__ instance (Cloud hosted free tier for example from [redislabs](https://redislabs.com/) will do as a starter)\n* a __project directory__ on your workstation to hold test cases and Botium configuration\n\n## Install Botium and Whatsapp Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-whatsapp\n\u003e cd \u003cyour working dir\u003e\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-whatsapp\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 Whatsapp Webhook to Botium\n\nOpen the file _botium.json_ in your working directory and add the webhook url and Redis connection settings.\n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"whatsapp\",\n      \"WHATSAPP_WEBHOOKURL\": \"...\",\n      \"SIMPLEREST_INBOUND_REDISURL\": \"redis://127.0.0.1:6379\"\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__Important: The `inbound-proxy` command has to be started with Botium CLI. Otherwise, Botium scripts will fail to receive any input or output messages from your chatbot!__\n\n## Running the Samples\n\nInstall botium-core as peerDependency \n\n    \u003e npm install --no-save botium-core\n\nAfterwards in the folder _samples/whatsapp-echo-bot_ is an example for a simple Whatsapp Webhook chatbot - it is connected to a **I Am Botium** chatbot endpoint doing some simple smalltalk. Start the webhook:\n\n    \u003e cd samples/whatsapp-echo-bot \u0026\u0026 npm install \u0026\u0026 npm start\n    \nFinally, navigate into the samples/simple and run `npm install`, start the inbound proxy server \nand run the test itself with the following commands:\n\n     \u003e cd samples/simple\n     \u003e npm install\n     \u003e npm run inbound\n     \u003e npm test\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __whatsapp__ to activate this connector.\n\n### WHATSAPP_WEBHOOKURL\nThe URL of your Whatsapp Business API webhook.\n\n### WHATSAPP_RECIPIENTID\nThe Whatsapp Id of the user.\n\nOptional. By default, a unique id is generated.\n\n## Open Issues and Restrictions\n\n* Currently only plain text messages are supported\n* Currently only individual receivers supported\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-whatsapp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-whatsapp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-whatsapp/lists"}