{"id":19450150,"url":"https://github.com/webexsamples/webex-bot-starter","last_synced_at":"2026-04-06T04:04:02.904Z","repository":{"id":42309739,"uuid":"224230399","full_name":"WebexSamples/webex-bot-starter","owner":"WebexSamples","description":"A template to deploy a bot in Webex Teams using the webex-node-bot-framework","archived":false,"fork":false,"pushed_at":"2024-06-28T20:06:02.000Z","size":2438,"stargazers_count":28,"open_issues_count":12,"forks_count":64,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-25T03:07:50.330Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WebexSamples.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":"2019-11-26T15:55:03.000Z","updated_at":"2024-09-12T03:05:02.000Z","dependencies_parsed_at":"2024-11-10T16:49:46.481Z","dependency_job_id":null,"html_url":"https://github.com/WebexSamples/webex-bot-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebexSamples%2Fwebex-bot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebexSamples%2Fwebex-bot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebexSamples%2Fwebex-bot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebexSamples%2Fwebex-bot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WebexSamples","download_url":"https://codeload.github.com/WebexSamples/webex-bot-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232046898,"owners_count":18464932,"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-11-10T16:35:31.548Z","updated_at":"2026-04-06T04:03:57.884Z","avatar_url":"https://github.com/WebexSamples.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Webex-Bot-Starter\n\n### Starter kit and template for a simple Webex bot\n\n_For a more detailed walkthorugh, see the [companion blog post here](https://developer.webex.com/blog/from-zero-to-webex-teams-chatbot-in-15-minutes)_\n\nThis is a very simple Webex node.JS bot application that serves as a template to be further extended. It features the [webex-node-bot-framework](https://github.com/WebexCommunity/webex-node-bot-framework) that simplifies development for Webex bots by abstracting away some of the complexity of the API calls and registering for events.\n\nHere is the bot in action:\n\n![What we're making](./images/webexbotstarter.gif)\n\n## Prerequisites:\n\n- [ ] node.js (minimum supported v8.0.0 \u0026 npm 2.14.12 and up)\n\n- [ ] [Sign up for Webex Developer Account](https://developer.webex.com/signup)\n\n---\n\n## Steps to get the bot working\n\n1. Create a Webex bot (save the API access token and username): https://developer.webex.com/my-apps/new/bot\n\n1. Copy the `.env.local` file to a file called `.env`\n\n1. Edit `.env` with the following values:\n\n- BOTTOKEN - Set this to the token for your bot that you got in step 1\n\n1. Turn on your bot server with `npm start`\n\n1. Create a space in Webex\n\n1. Add the bot (by its username) to the space in Webex\n\n1. @ mention your bot with `help` to get your first response: `@mybotname help`\n\n![First Response](./images/message.png)\n\n## Optional: Webhooks\n\nThe [webex-node-bot-framework](https://github.com/WebexCommunity/webex-node-bot-framework) supports WebSockets by default. If you would prefer your bot to operate via [Webhooks](https://developer.webex.com/docs/api/guides/webhooks), use these steps.\n\n1. Sign up for nGrok, then connect and start it on your machine (save the port number and public web address): https://ngrok.com/download\n\n1. After installing ngrok, run it on your local machine to get a public ip address, eg `ngrok http 3000 --region=eu`\n\n1. Copy the ip address displayed in the ngrok window, ie: : https://1234.eu.ngrok.io\n\n1. Edit `.env` with the following values:\n\n- PORT - Set this to the port you set when you started ngrok\n- WEBHOOKURL - Set this to the ip address that you copied\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebexsamples%2Fwebex-bot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebexsamples%2Fwebex-bot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebexsamples%2Fwebex-bot-starter/lists"}