Toolkits
Webex
WebexTools enable an Agent to interact with Cisco Webex, allowing it to send messages and list rooms.
Prerequisites
The following example requires the webexpythonsdk
library and a Webex access token which can be obtained from Webex Developer Portal.
To get started with Webex:
-
Create a Webex Bot:
- Go to the Developer Portal
- Navigate to My Webex Apps → Create a Bot
- Fill in the bot details and click Add Bot
-
Get your access token:
- Copy the token shown after bot creation
- Or regenerate via My Webex Apps → Edit Bot
- Set as WEBEX_ACCESS_TOKEN environment variable
-
Add the bot to Webex:
- Launch Webex and add the bot to a space
- Use the bot’s email (e.g. test@webex.bot)
Example
The following agent will list all spaces and send a message using Webex:
cookbook/tools/webex_tool.py
Toolkit Params
Parameter | Type | Default | Description |
---|---|---|---|
access_token | str | None | Webex access token for authentication. If not provided, uses WEBEX_ACCESS_TOKEN environment variable. |
send_message | bool | True | Enable sending messages to Webex spaces. |
list_rooms | bool | True | Enable listing Webex spaces/rooms. |
Toolkit Functions
Function | Description |
---|---|
send_message | Sends a message to a Webex room. Parameters: room_id (str) for the target room, text (str) for the message. |
list_rooms | Lists all available Webex rooms/spaces with their details including ID, title, type, and visibility settings. |