Broadcast Bot for Webex

The Bot can be used to broadcast a Webex message or a Card to multiple Webex Spaces. For example an important notification or a marketing information. The Bot replicates a received message to a set of Spaces or 1-1 communications it is a member of. The set of spaces is determined by Bot's configuration. It can be:

• all Spaces the Bot is member of
• only the Spaces which are owned by the message sender's Webex Org
• only the Spaces which are owned by the Bot's Org

Furthermore the message sender is checked. It can be:

• anyone
• anyone from the Bot's Org
• only a person from the configured list of senders

Additionally the Bot can be configured to limit its membership only to its own Org. If it is invited to a Space owned by a different Org, it posts a message that it is not allowed to be a member of external Spaces and leaves.

The Bot can be hosted as a publicly accessible Webhook, for example on AWS Lambda or Azure function to name a few.

The Card can be created using Card Designer.

How it works

The Bot subscribes its Webhook URL to multiple Webex events:

• new message created
• Space membership created, deleted or updated

Message broadcast

If the Bot receives a message in 1-1 communication (preferred way) or via @mention in a Space it runs the following algorithm:

1. check the message sender against Bot's configuration
2. get the list of Bot's membership in Spaces and 1-1 communications
3. use Bot's configuration to determine to which Spaces to replicate the message

The message is then replicated this way:

1. sender's identity is added to the beginning of the message
2. if there is a file attached, only the first file is replicated for broadcast (it is a limitation of Webex Messages API)
3. if the attached file type is JSON, the Bot attempts to send it as a Card. If it fails, the file is sent as a standard attachment.

Space membership

Once the Bot is added to a Space, it checks the membership part of its configuration for bots_own_org parameter. If the parameter is true, it checks the ownership of the Space to which it was added. If the Space is owned by a different Webex Org than the Bot's own, the Bot posts a message that it is not allowed to take part in communication outside its own Org. Otherwise it silently accepts the membership.
There is one more special case - a Space in announcement mode. In this case the Bot sends a 1-1 message to the person who added it to the Space, that it needs to be promoted to a Space moderator. Otherwise it won't be able to send messages in the Space.

Configuration

There is default_config.json which can be replaced by a file specified in CONFIG_FILE environment variable. The configuration has following sections:

1. source - determines the sender's check criteria:

• bots_own_org - only senders from the Bot's Org are accepted
• from_sender_list - if it is true, only the members of sender_list are accepted

2. destination - determines the destination Space selection criteria:

• bots_own_org - only the Spaces owned by Bot's Org are selected for message replication
• senders_own_org - only the Spaces from sender's Org are selected

3. membership - determines the Bot Space membership criteria:

• bots_own_org - Bot accepts only the membership in Spaces owned by its Org

How to install

Create a Webex Bot account

a) Login to https://developer.webex.com
b) Click on the user's icon in the top right corner and select My Webex Apps
c) Create a Bot. Note that Bot's e-mail address has to be unique across all Webex users, so include some org-specific info like [email protected].
d) Save Bot Access Token in a safe place, later you will copy it to WEBEX_TEAMS_ACCESS_TOKEN environment variable.

Install the Bot code

Install the code in a serverless environment of your choice. Bot is written in Python 3 using Flask WSGI. It was tested with Python version 3.9 on Azure and AWS Lambda. Sample configuration for Zappa deployment on AWS Lambda is included in zappa_settings.json and .boto_sample Note that zappa_settings.json refers to .env_dev and .env_prod files which need to be created from .env_sample. If you are going to run multiple instances in AWS Lambda, like dev and prod, you may need to create separate configuration files like config_dev.json and config_prod.json from default_config.json and refer to them in CONFIG_FILE environment variable in the .env_dev and .env_prod files.

Required Python modules are in requirements.txt, except for Zappa.

Configuration

Create a copy of default_config.json, for example config.json. Set the configuration parameters for source, destination and membership.

When hosting the Bot on Azure, create a file storage and save the config.json there. Then map the storage to the application. In the example below, the file is accessible to Bot at /config/config.json.

Set the environment variables of the application:

When hosting the Bot on AWS Lambda, make sure the config.json is in the same directory as the Bot code. The CONFIG_FILE environment variable then needs to be set to config.json in the respective .env_dev/.env_prod file.

Following environment variables need to be set:

1. WEBEX_TEAMS_ACCESS_TOKEN - contains the Bot access token
2. CONFIG_FILE - contains path to the configuration file, for example /config/config.json
3. LOCALE - locale string - see LOCALES in localization_strings.py, default is en_US. If needed, add your own locale and submit a patch to this project.

Alternatively python-dotenv can be used to set the environment variables. See .env_sample.

Setup webhook

After the Bot code is installed and running, try first opening a root URL of the application. You should get Hello world! page.

If it works, open the URL with /webhook suffix. For example https://my_web_page.service.com/webhook. The GET request triggers the Webhook setup. If it is successful, the Bot should display a summary web page.

The Bot is now running. Try sending it a message, file or a JSON Card. Then add the Bot to some Spaces or ask other users to add it to their Spaces.