Active |
---|
This application does not need additional settings. So you can make connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). only by using your login credentials or by following the instructions below . |
The Cisco Webex modulesa module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. enable you to monitor, create, retrieve, update, or delete messages, rooms, attachment actions, memberships, and teams in your Cisco Webex account.
Prerequisites
-
A Cisco Webex account — you can create one at web.webex.com.
Note | |
---|---|
The modulea module is an application or tool designed to handle specific business functions, such as CRM, project management, or inventory. The system's modular architecture allows you to activate only the modules you need, enabling customization and scalability as your business requirements evolve. dialog fields that are displayed in bold (in the Boost.spaceA platform that centralizes and synchronizes company data from internal and external sources, offering a suite of modules and addons for project management, CRM, data visualization, and more. Has many features to optimize your workflow! IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
-
Go to the Cisco Webex Integration page and click Create a new scenario. Open the Cisco Webex module’s Create a connection dialog.
-
Enter a name for the connection in the Connection name field, and click Continue.
After you click the Continue button, Boost.space Integrator will redirect you to the Cisco Webex website, where you will be prompted to log in and grant Boost.space Integrator access to your account.
Confirm the dialog by clicking the Accept button.
TriggersThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. when messages are added or deleted.
WebhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. name |
Enter the name for the webhook, e.g., Message Created. |
Connection |
|
Name |
Enter a user-friendly name for the webhook, only seen when you list all your webhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. via the API. |
Event |
Select whether to triggerThe initial event that starts a scenario. It can be an action, a scheduled time, or a custom event, and is essential to define at the beginning of each scenario. the module when a message is created or deleted. |
Filter |
Set the filter to return messages based on the filter settings only. |
Retrieves messages based on filter settings.
Connection |
|
Messages From |
Select whether to retrieve messages from:
|
Parent Message ID |
Enter (map) the ID of the message to retrieve replies for. |
Is Mentioned |
Enable to list messages with these people mentioned. Only the current API userCan use the system on a limited basis based on the rights assigned by the admin. or the person ID of the current user may be specified. Bots must include this parameter to list messages in group rooms (spacesIn Boost.space, a space is a subunit within a module that helps organize and categorize data, ensuring clarity even with large volumes. For example, within the Contacts module, you might have spaces like "Client Database" or "Supplier Database." Access to each space is restricted to users who have created it or have been granted access.). |
Before Date |
Enter the date and time to retrieve messages sent before a specified date and time. See the list of supported date and time formats. |
Before Message ID |
Enter (map) the ID of the message to retrieve messages sent before this message. |
Limit |
Set the maximum number of messages Boost.space Integrator will return during one execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Posts a message to the room or the specified person.
Connection |
|
Send To |
Select whether to send a message to:
|
Content Type |
Select whether you want to create a plain-text message or a markdown-formatted message. |
Text / Markdown |
Enter the content of the message in the corresponding format. Maximum 7439 characters. |
Attachment Type |
Select whether to attach a file or an adaptive card.
|
Parent Message ID |
Enter (map) the ID of the message you want to reply to. |
Retrieves message details.
Connection |
|
Message ID |
Enter (map) the ID of the message you want to retrieve details about. |
Deletes a message.
Connection |
|
Message ID |
Enter (map) the ID of the message you want to delete. |
Triggers when an attachment card is submitted.
Webhook name |
Enter the name for the webhook. |
Connection |
|
Name |
Enter a user-friendly name for the webhook, only seen when you list all your webhooks via the API. |
Filter |
Set the filter to return messages based on the filter settings only. |
Creates a new attachment action – clicks on a submit button in a card.
Connection |
|
Message ID |
Enter (map) the ID of the message that contains the attachment you want to click the submit button on. |
Inputs |
Enter the attachment action’s inputs key-value pairs. Example: |
Retrieves details for an attachment action.
Connection |
|
Attachment Action ID |
Enter (map) the ID of the attachment action you want to retrieve details for. |
Triggers when a room is created or updated.
Webhook name |
Enter the name for the webhook, e.g., Room Created. |
Connection |
|
Name |
Enter a user-friendly name for the webhook, only seen when you list all your webhooks via the API. |
Event |
Select whether to trigger the module when a room is created or deleted. |
Filter |
Set the filter to return rooms based on the filter settings. |
Retrieves rooms based on filter settings.
Connection |
|
Team ID |
Enter the ID of the team to list rooms associated with the team. |
Type |
Select the type of room you want to list:
|
Sort By |
Select the sorting order of the results. |
Limit |
Set the maximum number of rooms Boost.space Integrator will return during one execution cycle. |
Creates a room.
Connection |
|
Title |
Enter the name for the room. |
Team ID |
Select or enter the ID of the team with which this room is associated. |
Retrieves room details.
Connection |
|
Room ID |
Enter (map) or select the room you want to retrieve details for. |
Updates an existing room.
Connection |
|
Room ID |
Enter (map) or select the room you want to update. |
Title |
Enter the new name for the room. |
Triggers when membership is added, updated, or deleted.
Webhook name |
Enter the name for the webhook, e.g., Membership Deleted. |
Connection |
|
Name |
Enter a user-friendly name for the webhook, only seen when you list all your webhooks via the API. |
Event |
Select whether to trigger the module when a membership is created, updated, or deleted. |
Filter |
Set the filter to return memberships based on the filter settings. |
Retrieves membersIn Boost.space, a Member is a role within a space that permits an individual to view and manage records using existing statuses and labels. Members cannot manage other members or modify space settings. of the specified room.
Connection |
|
Room ID |
Enter (map or select) the ID of the room to list memberships associated with the room. |
Person ID |
Enter the ID of the person to list memberships associated with the person, or use the Search button to find the ID by user’s name or user’s email address. The |
Person Email |
Enter the person’s email address to list memberships associated with the person. The |
Limit |
Set the maximum number of memberships Boost.space Integrator will return during one execution cycle. |
Adds a person to a room.
Connection |
|
Add Membership By |
Select whether to specify the person by ID or email address:
|
Is Moderator |
Enable this option to set the person as a room moderator. |
Retrieves membership details.
Connection |
|
Membership ID |
Enter (map) or select via the Search button the ID of the membership you want to retrieve details for. |
Updates properties for a membership.
Connection |
|
Membership ID |
Enter (map) or select via the Search button the ID of the membership you want to update. |
Is Moderator |
Enable this option to set the participant as a room moderator. |
Room Hidden from Cisco Webex Clients |
Enable this option to set the room as hidden from the Webex clients. |
Deletes a membership.
Connection |
|
Membership ID |
Enter (map) or select via the Search button the ID of the membership you want to delete. |
Retrieves a list of teams in your Cisco Webex account.
Connection |
|
Limit |
Set the maximum number of teams Boost.space Integrator will return during one execution cycle. |
Creates a new team.
Connection |
|
Name |
Enter a user-friendly name for the team. |
Updates a team name.
Connection |
|
Team ID |
Enter (map) the ID of the team you want to update. |
Name |
Enter the new user-friendly name for the team. |
Deletes a team.
Connection |
|
Team ID |
Enter (map) the ID or select the team you want to delete. |
Retrieves a list of team members.
Connection |
|
Team ID |
Enter (map) the ID or select the team you want to list memberships for. |
Limit |
Set the maximum number of memberships Boost.space Integrator will return during one execution cycle. |
Adds a person to the team.
Connection |
|
Team ID |
Enter (map) the ID or select the team you want to add a person to. |
Add Team Membership By |
Select whether to specify the person you want to add to the team by the ID or email address:
|
Is Moderator |
Enable this option to set the person as a team moderator. |
Allows you to set the person as a moderator.
Connection |
|
Team ID |
Enter (map) the ID or select the team you want to update. |
Team Membership ID |
Select the memberIn Boost.space, a Member is a role within a space that permits an individual to view and manage records using existing statuses and labels. Members cannot manage other members or modify space settings. of the team whose permissions you want to update. |
Is Moderator |
Enable this option to set the person as a team moderator. |
Removes a member from the team.
Connection |
|
Team ID |
Enter (map) the ID or select the team you want to remove the user from. |
Team Membership ID |
Select the member whom you want to remove from the team. |
Triggers when an attachment action, membership, message, or room event occurs.
Webhook name |
Enter the name for the webhook, e.g., Message Created. |
Connection |
|
Name |
Enter a user-friendly name for the webhook, only seen when you list all your webhooks via the API. |
Allows you to perform a custom API call.
Connection |
||||
URL |
Enter a path relative to
|
|||
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|||
Headers |
Enter the desired request headers. You don’t need to add authorization headers; we’ve already added those for you. |
|||
Query String |
Enter the request query string. |
|||
Body |
Enter the body content for your API call. |
The following API call returns all messages in the specified room in your Webex Teams account:
URL:
/v1/messages
Method:
GET
Query String:
Key:
roomId
Value:
{room_ID}
The result can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. > Body > itemsItems are rows in records (order/request/invoice/purchase...).
In our example, 5 items were returned: