quickstart.md

Quickstart

Note: The steps below assume you have a working WebEx account & Nodejs 12+

1. Fetch repo & install dependencies

git clone https://github.com/valgaze/speedybot-starter
cd speedybot-starter
npm run setup

2. Set your bot access token

• If you have an existing bot, get its token here: https://developer.webex.com/my-apps

• If you don't have a bot, create one and save the token from here: https://developer.webex.com/my-apps/new/bot

Once you have the bot's token, save it to settings/config.json under the token field

3. Boot your Bot

npm start

If all went well, it should look something like this:

4. Run a "healthcheck" with the bot

To make sure all is well, add your bot from Step 1 in a 1-1 chat session and tell it "healthcheck"-- if everything is configured properly you should see something like this:

5. Extend

• From here, you can edit settings/handlers.ts and make your own handlers (& integrate with other services)

• See how to use $uperpowers to give your bot extra capabilities (get/set conversational contexts, store data, retrieve files, 3rdparty integrations, etc)

• Use the How-To doc to see how to use "special words" to intercept file-uploads/attachments, submit data from a card, etc

• Look into Adaptive Cards and other rich chat components: https://developer.webex.com/docs/api/guides/cards

• See the resources for further reading & inspiration