The Webex connector lets your AI agent act in each user's Webex account. Each user signs in to Webex once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 49 tools.
- Tools
- 49
- What they doRead · write · destructive
- 31 · 18 · 031 read18 write0 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Webex app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Webex connection
In AgentKit > Connections, create a Webex connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Webex connections use your own OAuth app. Register one with Webex and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Webex connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'webex'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Webex:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'webex_direct_messages_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "webex"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Webex:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="webex_direct_messages_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolwebex_attachment_action_getGet the data a person submitted from an Adaptive Card (an attachment action), by its ID.Read-onlyGet Card Submission
Get the data a person submitted from an Adaptive Card (an attachment action), by its ID. Returns id, type, messageId, personId, roomId, inputs (the submitted form values) and created. Use webex_attachment_action_get to read a card response; the ID arrives in an attachmentActions webhook event.
Inputs
attachment_action_idstringrequired- ID of the attachment action (card submission). Example: Y2lzY29zcGFyazovL3VzL0FUVEFDSE1FTlRfQUNUSU9OLzU0MUFFMzBFLUUyQzUtNERENi04NTM4LTgzOTRDODYzM0I3MQ
webex_direct_messages_listList the messages in the 1:1 (direct) conversation between the connected user and one person, newest first.Read-onlyList Direct Messages
List the messages in the 1:1 (direct) conversation between the connected user and one person, newest first. Returns an items array of messages with id, roomId, text, markdown, files, attachments, personEmail, parentId and created. Use webex_direct_messages_list when you know the other person but not the space ID. Use webex_messages_list for group spaces. Pass person_id or person_email.
Inputs
parent_idstring- Only list replies to this parent message (one thread). Example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvZWM1ZTIzZjAtN2RhMS0xMWU5LTg2NTgtZTkzYzNiODZjZmFm
person_emailstring- Email of the other person in the 1:1 conversation. Provide this or person_id. Example: john.andersen@example.com
person_idstring- ID of the other person in the 1:1 conversation. Provide this or person_email. Get it from webex_people_list or webex_me_get. Example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
webex_me_getGet the Webex profile of the connected user.Read-onlyGet My Profile
Get the Webex profile of the connected user. Returns the user's id, emails, displayName, firstName, lastName, avatar, orgId, created and status. Use webex_me_get to learn who is connected, for example to get their person ID. Use webex_person_get for anyone else.
Inputs
This tool takes no inputs.
webex_meeting_getGet one Webex meeting series, scheduled meeting or meeting instance by its ID.Read-onlyGet Meeting
Get one Webex meeting series, scheduled meeting or meeting instance by its ID. Returns the meeting's id, meetingNumber, title, agenda, start, end, timezone, recurrence, state, meetingType, hostEmail, webLink, sipAddress and dial-in details. Use webex_meeting_get when you have the meeting ID. Use webex_meetings_list to find meetings.
Inputs
meeting_idstringrequired- ID of the meeting series, scheduled meeting or meeting instance. Get it from webex_meetings_list. Example: 870f51ff287b41be84648412901e0402
currentboolean- For a meeting series: true returns the current scheduled occurrence, false or empty returns the whole series. Example: true
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
passwordstring- Meeting password, sent as the password request header. Needed only when the meeting is password protected and the connected user is not its host, cohost or invitee. Example: BgJep@4323
timezonestring- IANA time zone used for the timestamps in the response, sent as the timezone request header. Defaults to UTC when empty. Example: America/Los_Angeles
webex_meeting_invitee_getGet one meeting invitee by ID.Read-onlyGet Meeting Invitee
Get one meeting invitee by ID. Returns id, email, displayName, coHost, meetingId and panelist. Use webex_meeting_invitee_get when you have the invitee ID. Use webex_meeting_invitees_list to find it.
Inputs
meeting_invitee_idstringrequired- ID of the meeting invitee. Get it from webex_meeting_invitees_list. Example: 870f51ff287b41be84648412901e0402_2628962
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
webex_meeting_invitees_listList the invitees of a Webex meeting series, scheduled meeting or meeting instance.Read-onlyList Meeting Invitees
List the invitees of a Webex meeting series, scheduled meeting or meeting instance. Returns an items array of invitees with id, email, displayName, coHost, meetingId and panelist. Use webex_meeting_invitees_list to see who is invited or to find an invitee ID. Use webex_meeting_participants_list for who actually joined.
Inputs
meeting_idstringrequired- ID of the meeting. Get it from webex_meetings_list. Example: 870f51ff287b41be84648412901e0402
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
maxinteger- Maximum number of results to return in one response. Up to 100; Webex returns 10 when empty. Example: 50
paneliststring- Webinars only: true lists panelists, false lists attendees; empty lists both. Example: trueone of
truefalse
webex_meeting_participant_getGet one participant of a live or ended Webex meeting.Read-onlyGet Meeting Participant
Get one participant of a live or ended Webex meeting. Returns id, email, displayName, host, coHost, state, joinedTime, leftTime, video, muted and devices. Use webex_meeting_participant_get when you have the participant ID from webex_meeting_participants_list.
Inputs
participant_idstringrequired- ID of the participant; it combines the meeting ID and the participant. Example: 560d7b784f5143e3be2fc3064a5c4999_3c2e2338-e950-43bf-b588-573773ee43d1
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
webex_meeting_participants_listList the people who joined an in-progress or ended Webex meeting the connected user hosts.Read-onlyList Meeting Participants
List the people who joined an in-progress or ended Webex meeting the connected user hosts. Returns an items array of participants with id, email, displayName, host, coHost, state, joinedTime, leftTime and devices. Use webex_meeting_participants_list for attendance. Use webex_meeting_invitees_list for who was invited. Requires the meeting host or an admin.
Inputs
meeting_idstringrequired- ID of the meeting. For a series, the last instance is used. Personal room meeting IDs are not supported. Example: 0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044
breakout_session_idstring- Ended meetings only: list who joined this breakout session. Example: c84ba778-2f46-4dc6-9459-398694732d70
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
join_time_fromstring- Only participants who joined at or after this ISO 8601 time. The join window can be at most 7 days. Example: 2026-10-22T09:30:00Z
join_time_tostring- Only participants who joined before this ISO 8601 time. Example: 2026-10-25T09:30:00Z
maxinteger- Maximum number of results to return in one response. Up to 100; Webex returns 10 when empty. Example: 50
meeting_start_time_fromstring- Only instances that started after this ISO 8601 time (exclusive). Example: 2026-10-01T00:00:00Z
meeting_start_time_tostring- Only instances that started before this ISO 8601 time (exclusive). Example: 2026-10-31T00:00:00Z
timezonestring- IANA time zone used for the timestamps in the response, sent as the timezone request header. Defaults to UTC when empty. Example: America/Los_Angeles
webex_meeting_sites_listList the Webex sites the connected user can schedule meetings on, and which one is their default.Read-onlyList Meeting Sites
List the Webex sites the connected user can schedule meetings on, and which one is their default. Returns a sites array with siteUrl and default for each site. Use webex_meeting_sites_list to get a site_url for the meeting, recording and transcript tools.
Inputs
site_urlstring- Webex site to read the user from from, as a host name. Leave empty to use the user's default site(s). Get the sites with webex_meeting_sites_list. Example: example.webex.com
user_emailstring- Admins only: list the sites of this user instead of the connected user. Example: john.andersen@example.com
webex_meeting_summary_getGet the AI-generated summary of an ended Webex meeting instance.Read-onlyGet Meeting Summary
Get the AI-generated summary of an ended Webex meeting instance. Returns the summary's id, meetingId, notes (the summary text) and actionItems. Use webex_meeting_summary_get after a meeting ends. Find instances with summaries via webex_meetings_list has_summary true.
Inputs
meeting_idstringrequired- ID of an ended meeting instance. Series, scheduled, in-progress and personal room meeting IDs are not supported. Example: 0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044
webex_meeting_template_getGet one meeting template with its full meeting settings.Read-onlyGet Meeting Template
Get one meeting template with its full meeting settings. Returns id, name, locale, siteUrl, templateType, isDefault, isStandard and the meeting settings the template applies. Use webex_meeting_template_get to inspect a template before using its ID in webex_meeting_create.
Inputs
template_idstringrequired- ID of the meeting template. Get it from webex_meeting_templates_list. Example: N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
timezonestring- IANA time zone used for the timestamps in the response, sent as the timezone request header. Defaults to UTC when empty. Example: America/Los_Angeles
webex_meeting_templates_listList the meeting and webinar templates available to the connected user.Read-onlyList Meeting Templates
List the meeting and webinar templates available to the connected user. Returns an items array of templates with id, name, locale, siteUrl, templateType, isDefault and isStandard. Use webex_meeting_templates_list to pick a template_id for webex_meeting_create. Use webex_meeting_template_get for the full template.
Inputs
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
is_defaultboolean- true for only default templates, false for only non-default ones. Example: true
is_standardboolean- true for only standard templates, false for only custom ones. Example: true
localestring- Template locale. Webex uses en_US when empty. Example: en_US
site_urlstring- Webex site to read templates from from, as a host name. Leave empty to use the user's default site(s). Get the sites with webex_meeting_sites_list. Example: example.webex.com
template_typestring- Only meeting or webinar templates. Example: meetingone of
meetingwebinar
webex_meeting_transcript_downloadDownload the full text of a Webex meeting transcript as WebVTT or plain text.Read-onlyDownload Meeting Transcript
Download the full text of a Webex meeting transcript as WebVTT or plain text. Returns the transcript file content as text. Use webex_meeting_transcript_download for the whole transcript. Use webex_meeting_transcript_snippets_list for structured, speaker-tagged snippets.
Inputs
transcript_idstringrequired- ID of the transcript. Get it from webex_meeting_transcripts_list. Example: 5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9
formatstring- File format: vtt (WebVTT with timestamps, the Webex default) or txt (plain text). Example: txtone of
vtttxt host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
webex_meeting_transcript_snippets_listList the snippets (speaker-attributed lines) of a Webex meeting transcript.Read-onlyList Transcript Snippets
List the snippets (speaker-attributed lines) of a Webex meeting transcript. Returns an items array of snippets with id, text, personName, personEmail, offsetMillisecond and durationMillisecond. Use webex_meeting_transcript_snippets_list to know who said what. Use webex_meeting_transcript_download for the whole file.
Inputs
transcript_idstringrequired- ID of the transcript. Example: 5e01eeaadedb_M_0fc6ec11d9b6c909e04e1f6c76accda9
maxinteger- Maximum number of snippets to return. Example: 100
webex_meeting_transcripts_listList the transcripts of the connected user's ended Webex meetings, by time range or for one meeting instance.Read-onlyList Meeting Transcripts
List the transcripts of the connected user's ended Webex meetings, by time range or for one meeting instance. Returns an items array of transcripts with id, meetingId, meetingTopic, startTime, status, vttDownloadLink and txtDownloadLink. Use webex_meeting_transcripts_list to find a transcript ID. Then use webex_meeting_transcript_download for the full text or webex_meeting_transcript_snippets_list for speaker-tagged lines.
Inputs
fromstring- Start of the time range (inclusive), ISO 8601. Defaults to 7 days before to. Example: 2026-10-01T00:00:00Z
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
maxinteger- Maximum number of results to return in one response. Between 1 and 100; Webex returns 10 when empty. Example: 50
meeting_idstring- ID of an ended meeting instance (not a series or scheduled meeting). Get it from webex_meetings_list with meeting_type meeting. Example: 0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044
site_urlstring- Webex site to read transcripts from from, as a host name. Leave empty to use the user's default site(s). Get the sites with webex_meeting_sites_list. Example: example.webex.com
tostring- End of the time range (exclusive), ISO 8601. Defaults to now. Example: 2026-10-08T00:00:00Z
webex_meetings_listList the connected user's Webex meetings: series, scheduled occurrences or past meeting instances, filtered by time range, state or what they contain.Read-onlyList Meetings
List the connected user's Webex meetings: series, scheduled occurrences or past meeting instances, filtered by time range, state or what they contain. Returns an items array of meetings with id, meetingNumber, title, start, end, timezone, state, meetingType, hostEmail, webLink and sipAddress. Use webex_meetings_list to find meetings or past instances (meeting_type meeting) for recordings and transcripts. Use webex_meeting_get for one known meeting ID.
Inputs
currentboolean- For a meeting series: true (Webex default) returns the current scheduled meeting of the series, false returns the whole series. Example: false
fromstring- Start of the time range (inclusive), ISO 8601. Ignored with meeting_number, web_link or room_id. Example: 2026-10-01T00:00:00Z
has_chatboolean- For ended meeting instances: true for only meetings with a chat log, false for only those without. Example: false
has_recordingboolean- For ended meeting instances: true for only recorded meetings, false for only unrecorded ones. Example: true
has_summaryboolean- For ended meeting instances: true for only meetings with an AI summary, false for only those without. Example: true
has_transcriptionboolean- For ended meeting instances: true for only meetings with a transcript, false for only those without. Example: true
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
integration_tagstring- Only meetings carrying this external key, set by this integration when it created the meeting. Example: JIRA-1234
maxinteger- Maximum number of results to return in one response. Up to 100; Webex returns 10 when empty. Ignored with meeting_number, web_link or room_id. Example: 50
meeting_numberstring- Find the meeting with this meeting number. Cannot be combined with web_link or room_id; other filters are then ignored. Example: 123456789
meeting_series_idstring- List all occurrences and instances of this meeting series. Example: 870f51ff287b41be84648412901e0402
meeting_typestring- Kind of meeting objects to list: meetingSeries (default), scheduledMeeting (individual occurrences) or meeting (started or ended instances, needed for recordings, transcripts and summaries). Example: meetingone of
meetingSeriesscheduledMeetingmeeting room_idstring- ID of the Webex space (room). Find meetings linked to this space. Cannot be combined with meeting_number or web_link. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
scheduled_typestring- Only meetings of this scheduled type: meeting, webinar or personalRoomMeeting. Example: meetingone of
meetingwebinarpersonalRoomMeeting site_urlstring- Webex site to read meetings from, as a host name. Leave empty to use the user's default site(s). Get the sites with webex_meeting_sites_list. Example: example.webex.com
statestring- Only meetings in this state: active, scheduled, ready, lobby, inProgress, ended, missed or expired. Ended meetings appear about 15 minutes after they end. Example: endedone of
activescheduledreadylobbyinProgressendedmissedexpired timezonestring- IANA time zone used for the timestamps in the response, sent as the timezone request header. Defaults to UTC when empty. Example: America/Los_Angeles
tostring- End of the time range (exclusive), ISO 8601. Ignored with meeting_number, web_link or room_id. Example: 2026-10-31T00:00:00Z
web_linkstring- Find the meeting with this join page link (the URL itself, not encoded). Cannot be combined with meeting_number or room_id. Example: https://example.webex.com/example/j.php?MTID=m0123456789abcdef
webex_membership_getGet one space (room) membership by its ID.Read-onlyGet Space Membership
Get one space (room) membership by its ID. Returns id, roomId, personId, personEmail, personDisplayName, isModerator, isMonitor, isRoomHidden and created. Use webex_membership_get when you have the membership ID. Use webex_memberships_list to find it.
Inputs
membership_idstringrequired- ID of the space membership. Get it from webex_memberships_list. Example: Y2lzY29zcGFyazovL3VzL01FTUJFUlNISVAvMGQwYzkxYjYtY2U2MC00NzI1LWI2ZDAtMzQ1NWQ1ZDExZWYzOmNkZTFkZDQwLTJmMGQtMTFlNS1iYTljLTdiNjU1NmQyMjA3Yg
webex_memberships_listList space (room) memberships: who is in a space, or whether a given person is in it.Read-onlyList Space Memberships
List space (room) memberships: who is in a space, or whether a given person is in it. Returns an items array of memberships with id, roomId, personId, personEmail, personDisplayName, isModerator, isMonitor and created. Use webex_memberships_list to see a space's members or find a membership ID. Without room_id it lists the connected user's own memberships.
Inputs
maxinteger- Maximum number of results to return in one response. Webex returns 100 when empty. Example: 50
person_emailstring- Only the membership of the person with this email. Requires room_id. Example: john.andersen@example.com
person_idstring- Only this person's membership. Requires room_id. Get it from webex_people_list or webex_me_get. Example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
room_idstring- ID of the Webex space (room). List members of this space. Required when filtering by person. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
webex_message_getGet one Webex message by its ID.Read-onlyGet Message
Get one Webex message by its ID. Returns the message's id, roomId, roomType, text, markdown, html, files, attachments, personId, personEmail, mentionedPeople, parentId and created. Use webex_message_get when you have the message ID. Use webex_messages_list to read a space.
Inputs
message_idstringrequired- ID of the message. Get it from webex_messages_list. Example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk
webex_messages_listList messages in a Webex space (room), newest first, optionally only replies to a thread or messages that mention the connected user.Read-onlyList Messages
List messages in a Webex space (room), newest first, optionally only replies to a thread or messages that mention the connected user. Returns an items array of messages with id, roomId, text, markdown, files, attachments, personId, personEmail, parentId and created. Use webex_messages_list for group spaces. Use webex_direct_messages_list for a 1:1 conversation with one person.
Inputs
room_idstringrequired- ID of the Webex space (room). Messages are listed from this space. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
beforestring- Only list messages sent before this ISO 8601 time. Use it to page back through history. Example: 2016-04-21T19:01:55.966Z
before_messagestring- Only list messages sent before this message ID. Pass the oldest ID from the previous page to page back. Example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk
maxinteger- Maximum number of results to return in one response. Webex returns 50 when empty; the limit is 100 when mentioned_people is set. Example: 50
mentioned_peoplearray- Only list messages that mention these people. Only me (the connected user) or the connected user's own person ID is allowed. Bots must set this to list messages in group spaces. Example: ["me"]
parent_idstring- Only list replies to this parent message (one thread). Example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvZWM1ZTIzZjAtN2RhMS0xMWU5LTg2NTgtZTkzYzNiODZjZmFm
webex_people_listSearch the connected user's Webex organization directory by email, display name prefix or person IDs.Read-onlyList People
Search the connected user's Webex organization directory by email, display name prefix or person IDs. Returns an items array of people with id, emails, displayName, firstName, lastName, avatar, orgId, status and lastActivity. Use webex_people_list to find a person ID. Non-admin users must pass email or display_name. Use webex_person_get for one known ID.
Inputs
display_namestring- Find people whose display name starts with this text. Non-admin users must provide this or email. Example: John
exclude_statusboolean- When true, leave out presence status to make the query faster. Example: true
idsstring- Up to 85 person IDs separated by commas. Presence fields are not returned when this is set. Example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
maxinteger- Maximum number of results to return in one response. Webex returns 100 when empty. Example: 50
person_emailstring- Find the person with this email address. Non-admin users must provide this or display_name. Example: john.andersen@example.com
webex_person_getGet one person's Webex profile by person ID.Read-onlyGet Person
Get one person's Webex profile by person ID. Returns id, emails, displayName, nickName, firstName, lastName, avatar, orgId, created, status and lastActivity. Use webex_person_get when you have the ID. Use webex_people_list to search by email or name, and webex_me_get for the connected user.
Inputs
person_idstringrequired- ID of the person. Get it from webex_people_list or webex_me_get. Example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
webex_recording_getGet one Webex meeting recording, including its playback and download links.Read-onlyGet Recording
Get one Webex meeting recording, including its playback and download links. Returns id, meetingId, topic, createTime, durationSeconds, sizeBytes, format, playbackUrl, password and temporaryDirectDownloadLinks. Use webex_recording_get when you have the recording ID. Use webex_recordings_query to find recordings.
Inputs
recording_idstringrequired- ID of the recording. Get it from webex_recordings_query. Example: 4f914b1dfe3c4d11a61730f18c0f5387
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
site_urlstring- Webex site the recording belongs to, sent as the siteUrl request header. Example: example.webex.com
timezonestring- IANA time zone used for the timestamps in the response, sent as the timezone request header. Defaults to UTC when empty. Example: America/Los_Angeles
webex_room_getGet one Webex space (room) by its ID.Read-onlyGet Space
Get one Webex space (room) by its ID. Returns the space's id, title, type, isLocked, isPublic, description, teamId, creatorId, lastActivity and created. Use webex_room_get when you have the space ID. Use webex_rooms_list to find spaces.
Inputs
room_idstringrequired- ID of the Webex space (room). Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
webex_room_tab_getGet one space tab by its ID.Read-onlyGet Space Tab
Get one space tab by its ID. Returns id, roomId, roomType, displayName, contentUrl, creatorId and created. Use webex_room_tab_get when you have the tab ID. Use webex_room_tabs_list to find it.
Inputs
room_tab_idstringrequired- ID of the space tab. Get it from webex_room_tabs_list. Example: Y2lzY29zcGFyazovL3VzL1JPT01fVEFCLzBkMGM5MWI2LWNlNjAtNDcyNS1iNmQwLTM0NTVkNWQxMWVmMw
webex_room_tabs_listList the tabs (pinned web pages) of a Webex space.Read-onlyList Space Tabs
List the tabs (pinned web pages) of a Webex space. Returns an items array of tabs with id, roomId, roomType, displayName, contentUrl, creatorId and created. Use webex_room_tabs_list to see a space's tabs or find a tab ID.
Inputs
room_idstringrequired- ID of the Webex space (room). Tabs of this space are listed. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
webex_rooms_listList the Webex spaces (rooms) the connected user belongs to, optionally filtered by team or type.Read-onlyList Spaces
List the Webex spaces (rooms) the connected user belongs to, optionally filtered by team or type. Returns an items array of spaces with id, title, type (direct or group), isLocked, teamId, lastActivity and created. Use webex_rooms_list to find a space ID. Use webex_room_get when you already have the ID.
Inputs
fromstring- With org_public_spaces, only list spaces made public at or after this ISO 8601 time. Example: 2022-10-10T17:00:00.000Z
maxinteger- Maximum number of results to return in one response. Must be between 1 and 1000; Webex returns 100 when empty. Example: 50
org_public_spacesboolean- When true, list the organization's public spaces, joined and not joined, sorted by when they were made public. Cannot be combined with team_id, type or sort_by. Example: true
sort_bystring- Sort order: id, lastactivity (most recent activity first) or created. Cannot be combined with org_public_spaces. Example: lastactivityone of
idlastactivitycreated team_idstring- Only list spaces that belong to this team. Cannot be combined with org_public_spaces. Get team IDs from webex_teams_list. Example: Y2lzY29zcGFyazovL3VzL1RFQU0vMTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
tostring- With org_public_spaces, only list spaces made public before this ISO 8601 time. Example: 2022-10-11T17:00:00.000Z
typestring- Only list spaces of this type: direct for 1:1 spaces, group for group spaces. Cannot be combined with org_public_spaces. Example: groupone of
directgroup
webex_team_getGet one Webex team by its ID.Read-onlyGet Team
Get one Webex team by its ID. Returns the team's id, name, description, creatorId and created. Use webex_team_get when you have the team ID. Use webex_teams_list to find teams.
Inputs
team_idstringrequired- ID of the team. Get it from webex_teams_list. Example: Y2lzY29zcGFyazovL3VzL1RFQU0vMTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
webex_team_membership_getGet one team membership by its ID.Read-onlyGet Team Membership
Get one team membership by its ID. Returns id, teamId, personId, personEmail, personDisplayName, isModerator and created. Use webex_team_membership_get when you have the ID. Use webex_team_memberships_list to find it.
Inputs
team_membership_idstringrequired- ID of the team membership. Get it from webex_team_memberships_list. Example: Y2lzY29zcGFyazovL3VzL1RFQU1fTUVNQkVSU0hJUC8wZmNmYTJiOC1hZGNjLTQ1ZWEtYTc4Mi1lNDYwNTkyZjgxZWY6MTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
webex_team_memberships_listList the members of a Webex team.Read-onlyList Team Memberships
List the members of a Webex team. Returns an items array of team memberships with id, teamId, personId, personEmail, personDisplayName, isModerator and created. Use webex_team_memberships_list to see a team's members or find a team membership ID. Use webex_memberships_list for a space.
Inputs
team_idstringrequired- ID of the team. Get it from webex_teams_list. Example: Y2lzY29zcGFyazovL3VzL1RFQU0vMTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
maxinteger- Maximum number of results to return in one response. Webex returns 100 when empty. Example: 50
webex_teams_listList the Webex teams the connected user belongs to.Read-onlyList Teams
List the Webex teams the connected user belongs to. Returns an items array of teams with id, name, description, creatorId and created. Use webex_teams_list to find a team ID. Use webex_team_get for one known team.
Inputs
maxinteger- Maximum number of results to return in one response. Webex returns 100 when empty. Example: 50
webex_meeting_createSchedule a Webex meeting or recurring series, optionally with invitees, or start an instant meeting for a space.WriteCreate Meeting
Schedule a Webex meeting or recurring series, optionally with invitees, or start an instant meeting for a space. Returns the created meeting with id, meetingNumber, title, start, end, webLink, sipAddress, password and hostEmail. Use webex_meeting_create to schedule a meeting. Use webex_meeting_update to change an existing one and webex_meeting_invitee_create to invite more people later.
Inputs
titlestringrequired- Meeting title, up to 128 characters. Example: Weekly sync
adhocboolean- Create an instant (ad-hoc) meeting for the space given in room_id. Requires room_id. Example: false
agendastring- Meeting agenda, up to 1300 characters. Example: Review the Q4 roadmap
allow_any_user_to_be_co_hostboolean- Let any attendee with a host account on the site become a cohost when they join. Example: false
enabled_auto_record_meetingboolean- Record the meeting automatically. Example: true
enabled_join_before_hostboolean- Let attendees join before the host. Example: true
endstring- End date and time, ISO 8601. Must be after start. Required unless template_id is set or adhoc is true. Example: 2026-11-02T17:30:00-08:00
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
integration_tagsarray- External keys from your own system (for example a ticket ID) to attach to the meeting, so you can find it later with webex_meetings_list integration_tag. Example: ["JIRA-1234"]
inviteesarray- People to invite, up to 1000. Each needs an email and can set a displayName and coHost. If room_id is set and this is empty, all members of the space are invited. Example: [{"email": "brenda.song@example.com", "displayName": "Brenda Song"}]
join_before_host_minutesinteger- How many minutes before the start attendees can join, when enabled_join_before_host is true. Allowed values: 0, 5, 10 or 15. Example: 5
meeting_optionsobject- In-meeting options for attendees, such as whether chat, video, notes or file transfer are allowed. Example: {"enabledChat": true, "enabledVideo": true}
passwordstring- Meeting password. Must meet the site's password rules; Webex generates one when empty on create. Example: BgJep@43
recurrencestring- Recurrence rule in RFC 2445 format, for a recurring meeting series. Example: FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;COUNT=10
reminder_timeinteger- Minutes before the start to email the host a reminder. Example: 15
room_idstring- ID of the Webex space (room). Link the meeting to this space. Requires the spark:all scope. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
scheduled_typestring- meeting (default), webinar (needs a webinar session type) or personalRoomMeeting (schedule in the user's personal room). Example: meetingone of
meetingwebinarpersonalRoomMeeting send_emailboolean- Whether Webex emails the host and invitees about this meeting. Webex defaults to true. Example: false
site_urlstring- Webex site to read the meeting on from, as a host name. Leave empty to use the user's default site(s). Get the sites with webex_meeting_sites_list. Example: example.webex.com
startstring- Start date and time, ISO 8601. Must be in the future and before end. Required unless template_id is set or adhoc is true. Example: 2026-11-02T17:00:00-08:00
template_idstring- Meeting template to start from; start and end become optional. Get IDs from webex_meeting_templates_list. Example: N2Q3ZWE1ZjQyYjkyMWVhY2UwNTM4NmNhMjRhZDczMGU6VS0yMDA5NzItTUMtZW5fVVM
timezonestring- IANA time zone the meeting is scheduled in. Defaults to UTC. Example: America/Los_Angeles
webex_meeting_invitee_createInvite one person, by email, to a scheduled Webex meeting or series.WriteInvite to Meeting
Invite one person, by email, to a scheduled Webex meeting or series. Returns the new invitee with id, email, displayName, coHost, meetingId and panelist. Use webex_meeting_invitee_create to add someone after the meeting exists. Use the invitees field of webex_meeting_create when scheduling.
Inputs
emailstringrequired- Email address of the person to invite. Example: john.andersen@example.com
meeting_idstringrequired- ID of the meeting series or scheduled meeting. Inviting to a series invites to every occurrence. Example: 870f51ff287b41be84648412901e0402
co_hostboolean- Make the invitee an alternate host (cohost). Example: false
display_namestring- Display name of the invitee, up to 128 characters. Example: John Andersen
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
panelistboolean- Webinars only: make the invitee a panelist. Example: false
send_emailboolean- Whether Webex emails the invitee. Webex defaults to true. Example: true
webex_meeting_invitee_updateChange a meeting invitee's email, display name, cohost or panelist setting.WriteUpdate Meeting Invitee
Change a meeting invitee's email, display name, cohost or panelist setting. Returns the updated invitee. Use webex_meeting_invitee_update for invitees of a scheduled meeting or series; it does not apply to ended or ongoing instances. The email is always required.
- Idempotent
Inputs
emailstringrequired- Invitee's email address. Required; pass the current email to keep it. Example: john.andersen@example.com
meeting_invitee_idstringrequired- ID of the meeting invitee. Example: 870f51ff287b41be84648412901e0402_2628962
co_hostboolean- Make the invitee an alternate host (cohost). Example: false
display_namestring- Display name of the invitee, up to 128 characters. Example: John Andersen
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
panelistboolean- Webinars only: make the invitee a panelist. Example: false
send_emailboolean- Whether Webex emails the invitee. Webex defaults to true. Example: true
webex_meeting_join_links_getGenerate start and join links for a Webex meeting that open it directly, without signing in or typing the password.WriteGet Meeting Join Links
Generate start and join links for a Webex meeting that open it directly, without signing in or typing the password. Returns joinLink, startLink (for the host) and expiration. Use webex_meeting_join_links_get to hand someone a one-click link. Identify the meeting with exactly one of meeting_id, meeting_number or web_link.
Inputs
display_namestring- Participant display name for the link. Requires email. Example: Brenda Song
emailstring- Generate the link for this participant's email instead of the connected user. Example: brenda.song@example.com
expiration_minutesinteger- How long the links stay valid, 1 to 60 minutes. Example: 30
host_emailstring- Admins only: email of the host whose meeting this is. Example: john.andersen@example.com
meeting_idstring- ID of the meeting series or scheduled meeting. Provide exactly one of meeting_id, meeting_number or web_link. Example: 870f51ff287b41be84648412901e0402
meeting_numberstring- Meeting number. Not valid for ended meetings. Provide exactly one of meeting_id, meeting_number or web_link. Example: 123456789
passwordstring- Meeting password, needed when the meeting is protected and the user is not its host, cohost or invitee. Example: BgJep@43
registration_idstring- Registration ID, required for a webinar that uses registration IDs. Example: 1111
web_linkstring- The meeting's join page link. Provide exactly one of meeting_id, meeting_number or web_link. Example: https://example.webex.com/example/j.php?MTID=m0123456789abcdef
webex_meeting_updateChange a scheduled Webex meeting or series: title, time, agenda, password, recurrence or options.WriteUpdate Meeting
Change a scheduled Webex meeting or series: title, time, agenda, password, recurrence or options. Only the fields you pass change. Returns the updated meeting object. Use webex_meeting_update for scheduled meetings and series; ended, in-progress and ad-hoc space meetings cannot be changed. Changing start, end or recurrence of a series cancels its exceptional occurrences.
- Idempotent
Inputs
meeting_idstringrequired- ID of the meeting series or scheduled meeting to change. Example: 870f51ff287b41be84648412901e0402
agendastring- Meeting agenda, up to 1300 characters. Example: Review the Q4 roadmap
allow_any_user_to_be_co_hostboolean- Let any attendee with a host account on the site become a cohost when they join. Example: false
enabled_auto_record_meetingboolean- Record the meeting automatically. Example: true
enabled_join_before_hostboolean- Let attendees join before the host. Example: true
endstring- New end time, ISO 8601. Example: 2026-11-02T18:30:00-08:00
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
integration_tagsarray- External keys from your own system (for example a ticket ID) to attach to the meeting, so you can find it later with webex_meetings_list integration_tag. Example: ["JIRA-1234"]
join_before_host_minutesinteger- How many minutes before the start attendees can join, when enabled_join_before_host is true. Allowed values: 0, 5, 10 or 15. Example: 5
meeting_optionsobject- In-meeting options for attendees, such as whether chat, video, notes or file transfer are allowed. Example: {"enabledChat": true, "enabledVideo": true}
passwordstring- Meeting password. Must meet the site's password rules; Webex generates one when empty on create. Example: BgJep@43
recurrencestring- Recurrence rule in RFC 2445 format, for a recurring meeting series. Example: FREQ=WEEKLY;INTERVAL=1;BYDAY=MO;COUNT=10
reminder_timeinteger- Minutes before the start to email the host a reminder. Example: 15
send_emailboolean- Whether Webex emails the host and invitees about this meeting. Webex defaults to true. Example: false
startstring- New start time, ISO 8601. Example: 2026-11-02T18:00:00-08:00
timezonestring- IANA time zone the meeting is scheduled in. Defaults to UTC. Example: America/Los_Angeles
titlestring- New title, up to 128 characters. Example: Weekly sync (moved)
webex_membership_createAdd a person to a Webex space (room) by person ID or email, optionally as a moderator.WriteAdd Person to Space
Add a person to a Webex space (room) by person ID or email, optionally as a moderator. Returns the new membership with id, roomId, personId, personEmail, isModerator and created. Use webex_membership_create to invite someone to a space. Use webex_team_membership_create for a team. Provide person_id or person_email.
Inputs
room_idstringrequired- ID of the Webex space (room). The person is added to this space. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
is_moderatorboolean- Make the person a moderator of the space. Example: false
person_emailstring- Email of the person to add. Provide this or person_id. Example: john.andersen@example.com
person_idstring- ID of the person to add. Provide this or person_email. Get it from webex_people_list or webex_me_get. Example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
webex_membership_updateMake a space member a moderator or not, and hide or show a direct space for the connected user.WriteUpdate Space Membership
Make a space member a moderator or not, and hide or show a direct space for the connected user. Returns the updated membership. Use webex_membership_update to change moderator status. Both flags are required, so pass the current value of the one you are not changing.
- Idempotent
Inputs
is_moderatorbooleanrequired- Whether the member is a moderator of the space. Example: true
is_room_hiddenbooleanrequired- Hide a direct (1:1) space in the Webex app. A new message makes it visible again. Pass false to leave it visible. Example: false
membership_idstringrequired- ID of the space membership. Get it from webex_memberships_list. Example: Y2lzY29zcGFyazovL3VzL01FTUJFUlNISVAvMGQwYzkxYjYtY2U2MC00NzI1LWI2ZDAtMzQ1NWQ1ZDExZWYzOmNkZTFkZDQwLTJmMGQtMTFlNS1iYTljLTdiNjU1NmQyMjA3Yg
webex_message_createSend a message to a Webex space or directly to one person, as plain text or Markdown, optionally as a thread reply, with a file URL or an Adaptive Card.WriteSend Message
Send a message to a Webex space or directly to one person, as plain text or Markdown, optionally as a thread reply, with a file URL or an Adaptive Card. Returns the created message with id, roomId, text, markdown, files, personId and created. Use webex_message_create to post. Use webex_message_update to edit a message you sent. Provide exactly one destination: room_id, to_person_id or to_person_email.
Inputs
attachmentsarray- One content attachment, such as an Adaptive Card. Each item needs a contentType of application/vnd.microsoft.card.adaptive and the card JSON as content. Also set text as a fallback for clients that cannot show cards. Example: [{"contentType": "application/vnd.microsoft.card.adaptive", "content": {"type": "AdaptiveCard", "version": "1.0", "body": [{"type": "TextBlock", "text": "Hello"}]}}]
filesarray- Public URL of one file to attach. Webex downloads it and posts it to the space; only one file is allowed per message. Example: ["https://www.example.com/images/media.png"]
markdownstring- Message in Markdown, up to 7439 bytes. Example: **Project update** - the plan is published.
parent_idstring- Reply in the thread of this parent message. Example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvZWM1ZTIzZjAtN2RhMS0xMWU5LTg2NTgtZTkzYzNiODZjZmFm
room_idstring- ID of the Webex space (room). Post into this space. Provide this, to_person_id or to_person_email. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
textstring- Message in plain text, up to 7439 bytes. When markdown is also set, this is the fallback shown by clients that cannot render rich text. Provide text, markdown, files or attachments. Example: Project plan published.
to_person_emailstring- Send a private 1:1 message to this email address instead of a space. Example: julie@example.com
to_person_idstring- Send a private 1:1 message to this person ID instead of a space. Example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
webex_message_updateEdit the text or Markdown of a message the connected user sent; each message can be edited up to 10 times.WriteEdit Message
Edit the text or Markdown of a message the connected user sent; each message can be edited up to 10 times. Returns the updated message object. Use webex_message_update to fix a sent message. Messages with files or attachments cannot be edited. Use webex_message_create to send a new one.
- Idempotent
Inputs
message_idstringrequired- ID of the message to edit. Example: Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk
room_idstringrequired- ID of the Webex space (room). The space that contains the message. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
markdownstring- New Markdown content, up to 7439 bytes. Example: **Project update** - plan v2 is published.
textstring- New plain-text content, up to 7439 bytes. Provide text, markdown or both. Example: Project plan published (updated).
webex_recordings_querySearch the Webex meeting recordings the connected user hosted or that were shared with them, by time range, meeting, topic or status.WriteSearch Recordings
Search the Webex meeting recordings the connected user hosted or that were shared with them, by time range, meeting, topic or status. Returns an items array of recordings with id, meetingId, topic, createTime, durationSeconds, format, playbackUrl, downloadUrl and status. Use webex_recordings_query to find recordings. Use webex_recording_get for one recording's download links.
- Idempotent
Inputs
formatstring- Only recordings in this file format: MP4 or ARF. Example: MP4one of
MP4ARF fromstring- Start of the time range (inclusive), ISO 8601. Defaults to 7 days before to. Example: 2026-10-01T00:00:00Z
host_emailstring- Email of the meeting host to act on behalf of. Only works when the connected user is a Webex site admin with admin-level meeting scopes; leave empty for the connected user's own meetings. Example: john.andersen@example.com
integration_tagstring- Only recordings of meetings tagged with this external key by this integration. Example: JIRA-1234
maxinteger- Maximum number of recordings to return, 1 to 100. Webex returns 10 when empty. Example: 20
meeting_idstring- Only recordings of this meeting series, scheduled meeting or meeting instance. Example: 0ed74a1c0551494fb7a04e2881bf50ae_I_166022169160077044
service_typestring- Only recordings from this Webex service: MeetingCenter, EventCenter, SupportCenter or TrainingCenter. Example: MeetingCenterone of
MeetingCenterEventCenterSupportCenterTrainingCenter site_urlstring- Webex site to read recordings from from, as a host name. Leave empty to use the user's default site(s). Get the sites with webex_meeting_sites_list. Example: example.webex.com
statusstring- available (default) for normal recordings, deleted for recordings in the recycle bin, purged (compliance officers only). Example: availableone of
availabledeletedpurged timezonestring- IANA time zone used for the timestamps in the response, sent as the timezone request header. Defaults to UTC when empty. Example: America/Los_Angeles
tostring- End of the time range (exclusive), ISO 8601. Defaults to now. Example: 2026-10-08T00:00:00Z
topicstring- Only recordings whose topic matches this text (case-insensitive). Example: Weekly sync
webex_room_createCreate a Webex space (room); the connected user is added as its first member.WriteCreate Space
Create a Webex space (room); the connected user is added as its first member. Returns the new space's id, title, type, isLocked, teamId and created. Use webex_room_create for a group space. To start a 1:1 space, send a message with webex_message_create and to_person_email instead. Add people with webex_membership_create.
Inputs
titlestringrequired- Name of the new space. Example: Project Unicorn - Sprint 0
classification_idstring- Data classification to apply to the space, if your organization uses space classifications. Bots cannot set this when creating a space. Example: Y2lzY29zcGFyazovL3VzL0NMQVNTSUZJQ0FUSU9OL2YyMDUyZTgyLTU0ZjgtMTFlYS1hMmUzLTJlNzI
descriptionstring- Description of the space. Required when is_public is true. Example: Company Announcements
is_announcement_onlyboolean- When true, only moderators can post (announcement mode). The space must also be locked (is_locked true). Example: false
is_lockedboolean- When true, the space is locked (moderated) and the creator becomes a moderator. Example: false
is_publicboolean- When true, the space is public and anyone in the organization can find and join it. A public space needs a description. Example: false
team_idstring- Create the space inside this team. Get team IDs from webex_teams_list. Example: Y2lzY29zcGFyazovL3VzL1RFQU0vMTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
webex_room_tab_createAdd a tab that pins a web page (HTTPS URL) to a Webex space.WriteAdd Space Tab
Add a tab that pins a web page (HTTPS URL) to a Webex space. Returns the new tab with id, roomId, displayName, contentUrl and created. Use webex_room_tab_create to pin a link to a space. Use webex_room_tab_update to change an existing tab.
Inputs
content_urlstringrequired- HTTPS URL the tab opens. Example: https://www.example.com/dashboard
display_namestringrequired- Name shown on the tab. Example: Team dashboard
room_idstringrequired- ID of the Webex space (room). The tab is added to this space. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
webex_room_tab_updateChange the URL or name of a space tab.WriteUpdate Space Tab
Change the URL or name of a space tab. Returns the updated tab. Use webex_room_tab_update to edit a tab. All three fields are required, so pass the current values of those you keep.
- Idempotent
Inputs
content_urlstringrequired- HTTPS URL the tab opens. Example: https://www.example.com/dashboard-v2
display_namestringrequired- Name shown on the tab. Example: Team dashboard
room_idstringrequired- ID of the Webex space (room). The space that contains the tab. Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
room_tab_idstringrequired- ID of the space tab. Example: Y2lzY29zcGFyazovL3VzL1JPT01fVEFCLzBkMGM5MWI2LWNlNjAtNDcyNS1iNmQwLTM0NTVkNWQxMWVmMw
webex_room_updateUpdate a Webex space (room): rename it, change its description, lock it, move it into a team or change public or announcement mode.WriteUpdate Space
Update a Webex space (room): rename it, change its description, lock it, move it into a team or change public or announcement mode. Returns the updated space object. Use webex_room_update to change an existing space. The title is always required, so pass the current title to keep it. Use webex_room_create for a new space.
- Idempotent
Inputs
room_idstringrequired- ID of the Webex space (room). Get it from webex_rooms_list. Example: Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0
titlestringrequired- Title of the space. Required on every update; pass the current title to keep it. Example: Project Unicorn - Sprint 1
classification_idstring- Data classification for the space. Example: Y2lzY29zcGFyazovL3VzL0NMQVNTSUZJQ0FUSU9OL2YyMDUyZTgyLTU0ZjgtMTFlYS1hMmUzLTJlNzI
descriptionstring- New description. To remove the description, send a single space character. Example: Company Announcements
is_announcement_onlyboolean- Turn announcement mode on (true) or off (false). The space must be locked first. Example: true
is_lockedboolean- Lock (true) or unlock (false) the space. Example: true
is_publicboolean- Make the space public (true) or private (false). Any member can make a space private; only a compliance officer can make it public, and it needs a description. Example: false
is_read_onlyboolean- Compliance officers only: make a direct (1:1) space read-only so no new messages can be exchanged. Example: false
team_idstring- Move the space into this team. Only spaces not already in a team can be moved, and every moderator must be a member of the team. Example: Y2lzY29zcGFyazovL3VzL1RFQU0vMTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
webex_team_createCreate a Webex team; the connected user becomes its first member.WriteCreate Team
Create a Webex team; the connected user becomes its first member. Returns the new team's id, name, description, creatorId and created. Use webex_team_create for a new team. Add people with webex_team_membership_create and spaces with webex_room_create team_id.
Inputs
namestringrequired- Name of the team. Example: Build Squad
descriptionstring- Description of the team. Example: The A team
webex_team_membership_createAdd a person to a Webex team by person ID or email, optionally as a moderator.WriteAdd Person to Team
Add a person to a Webex team by person ID or email, optionally as a moderator. Returns the new team membership with id, teamId, personId, personEmail, isModerator and created. Use webex_team_membership_create to add someone to a team. Use webex_membership_create for a single space. Provide person_id or person_email.
Inputs
team_idstringrequired- ID of the team. Example: Y2lzY29zcGFyazovL3VzL1RFQU0vMTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
is_moderatorboolean- Make the person a team moderator. Example: false
person_emailstring- Email of the person to add. Provide this or person_id. Example: john.andersen@example.com
person_idstring- ID of the person to add. Provide this or person_email. Get it from webex_people_list or webex_me_get. Example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY
webex_team_membership_updateMake a team member a moderator or remove their moderator role.WriteUpdate Team Membership
Make a team member a moderator or remove their moderator role. Returns the updated team membership. Use webex_team_membership_update to change team moderator status. Use webex_membership_update for a space.
- Idempotent
Inputs
is_moderatorbooleanrequired- Whether the member is a team moderator. Example: true
team_membership_idstringrequired- ID of the team membership. Example: Y2lzY29zcGFyazovL3VzL1RFQU1fTUVNQkVSU0hJUC8wZmNmYTJiOC1hZGNjLTQ1ZWEtYTc4Mi1lNDYwNTkyZjgxZWY6MTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
webex_team_updateRename a Webex team or change its description.WriteUpdate Team
Rename a Webex team or change its description. Returns the updated team. Use webex_team_update to edit a team. The name is always required; pass the current name to keep it.
- Idempotent
Inputs
namestringrequired- Team name. Required on every update; pass the current name to keep it. Example: Build Squad
team_idstringrequired- ID of the team. Example: Y2lzY29zcGFyazovL3VzL1RFQU0vMTNlMThmNDAtNDJmYy0xMWU2LWE5ZDgtMjExYTBkYzc5NzY5
descriptionstring- New team description. Example: The A team
No tools match.
