This document, and the accompanying bot program, are here to help you build your own bot. Feel free to use this as a starting point, and then customize your bot with extra features, which will suit your needs best.

Sign up for a free account at the below site.

https://pipedream.com/auth/signup

Login to the Webex Developer site, and create a bot filling in the required fields.

https://developer.webex.com/my-apps

After you create your bot, copy the access token, and then login to pipedream.com, and goto:

Settings > Environment Variables > New Environment Variable

Note: The Name value must match exactly, as the code will look for it by this name

The way you will create messages for the bot to send out, is by creating a special administrative space, and sending messages to your bot. Only people inside this space, who mention the bot by name, will cause the bot to distribute messages around. Be careful who you let in to this special space.

Login to the Webex Developer site, and get a listing of all rooms your bot is in.

TIP: You will need to swap over to your Bot’s access token, otherwise, this will list all of your own space,s instead of all of your Bot’s spaces.

https://developer.webex.com/docs/api/v1/rooms/list-rooms

After you get your Admin room ID, copy the room ID, and then login to pipedream.com, and goto:

Settings > Environment Variables > New Environment Variable

Note: The Name value must match exactly, as the code will look for it by this name

While we're already in the environment variables spot on pipedream.com, let's create our Webhook secret.

Settings > Environment Variables > New Environment Variable

Note: The Name value must match exactly, as the code will look for it by this name

Login to pipdream.com and goto:

Workflows > New > New HTTP / Webhook Requests

Rename this new workflow from Untitled Workflow to something useful that you like (e.g., My Announcement Bot), then press:

Save and continue

Copy and paste the unique URL given, for later reference; this is how Webex will trigger your bot.

Click the small white plus sign in the small grey box to add a new step, and select:

Run custom code

Copy and paste the bot code from this github repository, into the code editor in pipedream, replacing all of the default code which showed up in pipedream by default.

To finish, click on:

Deploy

Now you will need to adjust the timeout for your workflow to 300 seconds in the following place:

Workflows > the workflow you just created > Settings > Execution Controls > Timeout

Login to the Webex Developer site, and create a webhook using the following settings.

TIP: You will need to swap over to your Bot’s access token, otherwise, this will create the webhook for you and not for your bot.

https://developer.webex.com/docs/api/v1/webhooks/create-a-webhook

Example filter: mentionedPeople=me&roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYzc3YWIyNDAtYjkyYy0xMWVkLTg2NTItMDdmMTM2ZTJhNzdk

Login to the Webex Developer site, and create two webhooks using the following settings.

TIP: You will need to swap over to your Bot’s access token, otherwise, this will create the webhook for you and not for your bot.

https://developer.webex.com/docs/api/v1/webhooks/create-a-webhook

Bot Email Address: This is just your bot’s username followed by “@webex.bot”

Example filter: personEmail=[email protected]

Create a new space with you, the bot, and optionally anyone else who you’d like to test with. Now, notice in the Admin space, that you are alerted to this new membership!

Inside of your Admin space, mention the bot by name, use the /send command, and then type out your test message and send it.

Note: The code imposes a minimum of word count, in order for it to announce your message to all spaces. This protects you from messing up a command to the bot, and the bot mistakenly thinking you meant to send that message to all spaces. You can adjust that value in the code if you prefer a smaller or larger word count.

You can ask your bot for some info; just mention your bot in the Admin space, and send one of the following commands:

File attachments are currently supported; however, the Webex API limits us to 1 attachment only during a message post, and a maximum upload size of 100MB. It might be a better option to just send a link to the file instead, but it’s up to you.

Don't expect ECM files shared to the bot to work, these simply do not work.

Unknown support for this, since I do not use it myself.

This is a low scale, low volume solution, hence the free account on pipedream.com. Presently, if you add the bot to more than 100 spaces, the bot will not only be slow (especially if sending a 100MB file), due to how many spaces it has to message, but only a random set of 100 spaces from the total spaces list will be used. If you need truly large scale mass messaging, this is not the solution for you. Feel free to build upon what you have so far.

The free account let’s you post quite a bit, but there are limits. Note that the limits specified really do not apply to how many spaces you can send to, rather, it’s how many messages you send to your bot. If you feel like you need more, you can always pay for more: https://pipedream.com/pricing