Webex Messaging
The Webex Messaging APIs offer robust programmatic access to messaging features within Webex, including sending and receiving messages, managing spaces,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Webex Messaging APIs offer robust programmatic access to messaging features within Webex, including sending and receiving messages, managing spaces, memberships, attachments, and moderating content. These APIs enable integration with bots, workflow automation, notification systems, and custom messaging solutions to enhance team collaboration and productivity. Use cases include building chatbots, integrating with ticketing or alerting platforms, automating onboarding flows, and creating custom collaboration experiences tailored to business needs.
Endpoints 63
Attachment Actions
- POSTCreate an Attachment Action
/attachment/actionsCreate a new attachment action. - GETGet Attachment Action Details
/attachment/actions/:idShows details for a attachment action, by ID. Specify the attachment action ID in the id URI parameter.
ECM folder linking
- GETList ECM folder
/room/linkedFolders?roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0Lists the ECM folder of a room specified by the roomId query parameter. - POSTCreate an ECM folder configuration
/room/linkedFoldersAdds an existing ECM folder to a room as (default or reference) file storage. There is no data validation happening for the request. Please ensure the correct… - GETGet ECM Folder Details
/room/linkedFolders/:idGet details for a room ECM folder with the specified folder id. - PUTUpdate an ECM Linked Folder
/room/linkedFolders/:idUpdates the configuration of the specified Room folder. There is no data validation happening for the request. Please ensure the correct driveId and itemId.… - DELETEUnlink an ECM linked folder
/room/linkedFolders/:idUnlinks the room-linked folder with the specified ID from the space.
Events
- GETList Events
/eventsList events in your organization. Several query parameters are available to filter the events returned in the response. Long result sets will be split into… - GETGet Event Details
/events/:eventIdShows details for an event, by event ID. Specify the event ID in the eventId parameter in the URI.
Hybrid Data Security
- GETGet organization details
/hds/organizations/:organizationIdRetrieve details for an Hybrid Data Security organization, such as the organization name, type of organization. To obtain the Organization ID needed for this… - GETList clusters for an Hybrid Data Security organization
/hds/organizations/:organizationId/clustersRetrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. To… - GETGet cluster details
/hds/clusters/:clusterIdRetrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in… - GETList nodes for an Hybrid Data Security cluster
/hds/clusters/:clusterId/nodesRetrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. To… - GETGet node details
/hds/nodes/:nodeIdRetrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details,… - GETGet database details for the Hybrid Data Security organization
/hds/organizations/:organizationId/databaseRetrieve details of database information for an Hybrid Data Security organization, such as database type and version used. To obtain the Organization ID… - GETGet Multi-Tenant Hybrid Data Security organization details
/hds/organizations/:organizationId/tenantsRetrieve details of Multi-Tenant Hybrid Data Security organization such as Organization Name and ID, CMK state and state of Tenants Organizations. To obtain… - GETGet alarms for an Hybrid Data Security node
/hds/nodes/:nodeId/alarms?from=2025-06-15T15:53:00Z&to=2025-06-16T15:53:00ZReturns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). To obtain the Node ID needed for this API, use… - GETGet test results for Hybrid Data Security node
/hds/testResults/nodes/:nodeId/networkTestGet the latest results of the network tests triggered for a single Hybrid Data Security node. The test results are generated as part of the Network Test… - GETGet resource usage for an Hybrid Data Security node
/hds/nodes/:nodeId/resourceUsage?from=2025-06-15T15:53:00Z&to=2025-06-15T35:53:00ZRetrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. To obtain the Node ID needed for… - GETGet availability details for Hybrid Data Security cluster
/hds/clusters/:clusterId/availability?from=2021-09-15T15:53:00Z&to=2021-09-15T17:53:00ZGet the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online,…
Memberships
- GETList Memberships
/membershipsLists all room memberships. By default, lists memberships for rooms to which the authenticated user belongs. Use query parameters to filter the response. Use… - POSTCreate a Membership
/membershipsAdd someone to a room by Person ID or email address, optionally making them a moderator. Compliance Officers cannot add people to empty (team) spaces. - GETGet Membership Details
/memberships/:membershipIdGet details for a membership by ID. Specify the membership ID in the membershipId URI parameter. - PUTUpdate a Membership
/memberships/:membershipIdUpdates properties for a membership by ID. Specify the membership ID in the membershipId URI parameter. - DELETEDelete a Membership
/memberships/:membershipIdDeletes a membership by ID. Specify the membership ID in the membershipId URI parameter. The membership for the last moderator of a Team's General space may…
Messages
- GETList Messages
/messages?roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0Lists all messages in a room. Each message will include content attachments if present. The list sorts the messages in descending order by creation date. Long… - POSTCreate a Message
/messagesPost a plain text or rich text message, and optionally, a file attachment attachment, to a room. The files parameter is an array, which accepts multiple… - GETList Direct Messages
/messages/directList all messages in a 1:1 (direct) room. Use the personId or personEmail query parameter to specify the room. Each message will include content attachments… - GETGet Message Details
/messages/:messageIdShow details for a message, by message ID. Specify the message ID in the messageId parameter in the URI. - PUTEdit a Message
/messages/:messageIdUpdate a message you have posted not more than 10 times. Specify the messageId of the message you want to edit. Edits of messages containing files or… - DELETEDelete a Message
/messages/:messageIdDelete a message, by message ID. Specify the message ID in the messageId parameter in the URI.
People
- GETList People
/peopleList people in your organization. For most users, either the email or displayName parameter is required. Admin users can omit these fields and list all users… - POSTCreate a Person
/peopleCreate a new user account for a given organization. Only an admin can create a new user account. At least one of the following body parameters is required to… - GETGet Person Details
/people/:personIdShows details for a person, by ID. Response properties associated with a user's presence status, such as status or lastActivity, will only be displayed for… - PUTUpdate a Person
/people/:personIdUpdate details for a person, by ID. Specify the person ID in the personId parameter in the URI. Only an admin can update a person details. Include all details… - DELETEDelete a Person
/people/:personIdRemove a person from the system. Required Administrator Roles: The following administrators have permission to use this API: Customer Organization: Full… - GETGet My Own Details
/people/meGet profile details for the authenticated user. This is the same as GET /people/{personId} using the Person ID associated with your Auth token. Admin users…
Room Tabs
- GETList Room Tabs
/room/tabs?roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0Lists all Room Tabs of a room specified by the roomId query parameter. - POSTCreate a Room Tab
/room/tabsAdd a tab with a specified URL to a room. - GETGet Room Tab Details
/room/tabs/:idGet details for a Room Tab with the specified room tab ID. - PUTUpdate a Room Tab
/room/tabs/:idUpdates the content URL of the specified Room Tab ID. - DELETEDelete a Room Tab
/room/tabs/:idDeletes a Room Tab with the specified ID.
Rooms
- GETList Rooms
/roomsList rooms to which the authenticated user belongs to. The title of the room for 1:1 rooms will be the display name of the other person. Please use the… - POSTCreate a Room
/roomsCreates a room. The authenticated user is automatically added as a member of the room. See the Memberships API to learn how to add more people to the room. To… - GETGet Room Details
/rooms/:roomIdShows details for a room, by ID. The title of the room for 1:1 rooms will be the display name of the other person. When a Compliance Officer lists 1:1 rooms,… - PUTUpdate a Room
/rooms/:roomIdUpdates details for a room, by ID. Specify the room ID in the roomId parameter in the URI. A space can only be put into announcement mode when it is locked.… - DELETEDelete a Room
/rooms/:roomIdDeletes a room, by ID. Deleted rooms cannot be recovered. As a security measure to prevent accidental deletion, when a non moderator deletes the room they are… - GETGet Room Meeting Details
/rooms/:roomId/meetingInfoDeprecated. <div> <callout type="warning"> The meetingInfo API is deprecated and will be EOL on Jan 31, 2025. Meetings in the WSMP must be scheduled and…
Team Memberships
- GETList Team Memberships
/team/memberships?teamId=Y2lzY29zcGFyazovL3VzL1RFQU0vMTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5Lists all team memberships for a given team, specified by the teamId query parameter. Use query parameters to filter the response. - POSTCreate a Team Membership
/team/membershipsAdd someone to a team by Person ID or email address, optionally making them a moderator. - GETGet Team Membership Details
/team/memberships/:membershipIdShows details for a team membership, by ID. Specify the team membership ID in the membershipId URI parameter. - PUTUpdate a Team Membership
/team/memberships/:membershipIdUpdates a team membership, by ID. Specify the team membership ID in the membershipId URI parameter. - DELETEDelete a Team Membership
/team/memberships/:membershipIdDeletes a team membership, by ID. Specify the team membership ID in the membershipId URI parameter. The team membership for the last moderator of a team may…
Teams
- GETList Teams
/teamsLists teams to which the authenticated user belongs. - POSTCreate a Team
/teamsCreates a team. The authenticated user is automatically added as a member of the team. See the Team Memberships API to learn how to add more people to the team. - GETGet Team Details
/teams/:teamIdShows details for a team, by ID. Specify the team ID in the teamId parameter in the URI. - PUTUpdate a Team
/teams/:teamIdUpdates details for a team, by ID. Specify the team ID in the teamId parameter in the URI. - DELETEDelete a Team
/teams/:teamIdDeletes a team, by ID. Specify the team ID in the teamId parameter in the URI.
Webhooks
- GETList Webhooks
/webhooksList all of your webhooks. - POSTCreate a Webhook
/webhooksCreates a webhook. To learn more about how to create and use webhooks, see The Webhooks Guide. - GETGet Webhook Details
/webhooks/:webhookIdShows details for a webhook, by ID. Specify the webhook ID in the webhookId parameter in the URI. - PUTUpdate a Webhook
/webhooks/:webhookIdUpdates a webhook, by ID. You cannot use this call to deactivate a webhook, only to activate a webhook that was auto deactivated. The fields that can be… - DELETEDelete a Webhook
/webhooks/:webhookIdDeletes a webhook, by ID. Specify the webhook ID in the webhookId parameter in the URI.
API details
- Authentication
- A bearer token in the Authorization header
OAuth 2.0 (authorization code flow)
OAuth 2.0 (authorization code flow) with 9 scopes - Operations
- 63 operations on 36 pathsGET 35POST 10PUT 9DELETE 9
1 marked deprecated - Main resources
- Hybrid Data Security 11Messages 6People 6Rooms 6ECM folder linking 5Memberships 5Room Tabs 5Team Memberships 5Teams 5Webhooks 5
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Webex's published OpenAPI description (webex/webex-openapi-specs) (CC-BY-4.0)
How to test the Webex Messaging in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Webex Messaging collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create an Attachment Action” (POST /attachment/actions), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Webex Messaging?
The Webex Messaging APIs offer robust programmatic access to messaging features within Webex, including sending and receiving messages, managing spaces,… It is listed under Communication and has 63 endpoints.
Who publishes the Webex Messaging?
It is listed from Webex's public API description (an OpenAPI document), not published by Webex on Swastik Codes. Anyone who controls webex.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Webex Messaging?
It accepts 3 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow); OAuth 2.0 (authorization code flow) with 9 scopes.
How many endpoints does the Webex Messaging have?
63 operations on 36 paths (35 GET, 10 POST, 9 PUT, 9 DELETE). The largest groups are Hybrid Data Security, Messages, People, Rooms.
Is forking the Webex Messaging free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.