This guide details how to run your bot locally (ie, running on a dev machine or a private network), and make it talk with the Webex cloud platform.
- Start you bot
- Check your bot is healthy
- Expose your bot
- Create a webhook
Skip this (if you have already started your bot)
Here are the steps to install this project samples and run them
- Clone the repo
- Install dependencies
- Run an example
# Clone repo
> git clone https://github.com/CiscoDevNet/node-sparkbot-samples
# Install dependencies
> cd node-sparkbot-samples
> npm install
# Run an example
# add an ACCESS_TOKEN environment variable to configure your bot with the Webex Teams API access token of your bot account
> DEBUG=sparkbot*,samples* ACCESS_TOKEN=123456789 node templates/onEvent-all-all.js
...
bot started at http://localhost:8080/
GET / for health checks
POST / receives Webhook eventsHit localhost to check your bot is running, either via your Web browser or via CURL (see below) You should get back an JSON payload with your bot properties.
# Ping your bot
> curl http://localhost:8080
...
{
"message": "Congrats, your webhook is up and running",
"since": "2016-09-01T13:15:39.425Z",
"listeners": [
...To expose your boot on the internet, we'll leverage a tunnelling tool. You may pick any tool, the steps below leverage localtunnel.
There you need to choose a unique subdomain name, which localtunnel will use to create your bot public internel URL.
Replace in the following steps by your bot subdomain name.
Note : make sure you hit your bot secured HTTPS endpoint.
# Install local tunnel
> npm install localtunnel -g
# Create the tunnel
> lt -s <yourbot> -p 8080
your url is: http://<yourbot>.localtunnel.me
# In another terminal, check your bot is accessible
> curl https://<yourbot>.localtunnel.me/
{
"message": "Congrats, your bot is up and running",
"since": "2016-09-01T13:15:39.425Z",
"tip": "Register your bot as a WebHook to start receiving events: https://developer.webex.com/endpoint-webhooks-post.html",
"listeners": [
"messages/created"
],
"token": true,
"account": {
"type": "human",
"person": {
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85MmIzZGQ5YS02NzVkLTRhNDEtOGM0MS0yYWJkZjg5ZjQ0ZjQ",
"emails": [
"stsfartz@cisco.com"
],
"displayName": "Steve Sfartz",
"avatar": "https://1efa7a94ed216783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~c2582d2fb9d11e359e02b12c17800f09~aqSu09sCTVOOx45HJCbWHg==~1600",
"created": "2016-02-04T15:46:20.321Z"
}
},
"interpreter": {
"prefix": "/",
"trimMention": true,
"ignoreSelf": false
},
"commands": [
"help"
]
}Last step, is to create a Webhook for your bot to start receiving events for Webex Teams.
This can be done via the Webex Developer Portal / Create a WebHook interactive documentation, but also via Postman or a CURL command as will see right after.
For the scope of this example, we'll associate our bot to all resources and events.
Note: even if our webhook can process all events, you can register a webhook with a more limited set of events. Then Webex will then invoke your webhook only if those events happen (whatever your bot can process).
As an alternative, you can run this CURL command.
> curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_SPARK_TOKEN" -d '{
"name": "Bot Samples",
"resource": "all",
"event": "all",
"targetUrl": "https://yourbot.localtunnel.me/"
}' "https://api.ciscospark.com/v1/webhooks/"Or you can also create this webhook via Postman.
