> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webex

> How to set up the Webex connector, plus the actions and events that are available.

![Webex](https://stackone-logos.com/api/webex/filled/svg)

Previewv4.0.2[See changelog](https://docs.stackone.com/connectors/webex/changelog.md)

[115 actions](#actions) · [27 events](#events) · 3 auth methods

IAM
Messaging
Meetings

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/webex/guides/connector-profile/oauth-2-0.md)
>
> The Webex integration credentials are configured once on the StackOne connector profile, so users connect by logging in...

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/webex/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Requires a Webex Service App authorized by a Full Admin in Control Hub. Calls run as a machine account in the organizati...

> [card] [Access Token (Bot) · Connector Profile](https://docs.stackone.com/connectors/webex/guides/connector-profile/access-token-bot.md)
>
> Uses the access token of a Webex bot you create. Calls run as the bot, which sees only messages that mention it in group...

Optionally, configure receiving Events for Webex into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/webex/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/webex/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/webex/guides/link-account/oauth-2-0-client-credentials.md)

> [card] [Access Token (Bot) · Link Account](https://docs.stackone.com/connectors/webex/guides/link-account/access-token-bot.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Access Token (Bot)

OAuth 2.0

OAuth 2.0 (Client Credentials)

No auth methods found

Scopes

Select all
|
Clear

analytics:read\_all

audit:events\_read

meeting:admin\_config\_read

meeting:admin\_participants\_read

meeting:admin\_preferences\_read

meeting:admin\_preferences\_write

meeting:admin\_recordings\_read

meeting:admin\_recordings\_write

meeting:admin\_schedule\_read

meeting:admin\_schedule\_write

meeting:admin\_transcripts\_read

meeting:participants\_read

meeting:participants\_write

meeting:preferences\_read

meeting:preferences\_write

meeting:schedules\_read

meeting:schedules\_write

meeting:transcripts\_read

spark-admin:devices\_read

spark-admin:devices\_write

spark-admin:hybrid\_clusters\_read

spark-admin:hybrid\_connectors\_read

spark-admin:licenses\_read

spark-admin:locations\_read

spark-admin:locations\_write

spark-admin:organizations\_read

spark-admin:people\_read

spark-admin:people\_write

spark-admin:recordings\_read

spark-admin:recordings\_write

spark-admin:reports\_read

spark-admin:reports\_write

spark-admin:resource\_group\_memberships\_read

spark-admin:resource\_group\_memberships\_write

spark-admin:resource\_groups\_read

spark-admin:roles\_read

spark-admin:telephony\_config\_write

spark-admin:workspaces\_read

spark-admin:workspaces\_write

spark-compliance:events\_read

spark:memberships\_read

spark:memberships\_write

spark:messages\_read

spark:messages\_write

spark:organizations\_read

spark:people\_read

spark:recordings\_read

spark:recordings\_write

spark:rooms\_read

spark:rooms\_write

spark:team\_memberships\_read

spark:team\_memberships\_write

spark:teams\_read

spark:teams\_write

spark:webhooks\_read

spark:webhooks\_write

No scopes found

115 actions

ActionDescriptionRequired scopes

List Admin Audit Events`webex_list_admin_audit_events`

List admin audit events in your organization with filtering options

`audit:events_read`

List Recordings (Admin/Compliance Officer)`webex_list_recordings_admin`

List all recordings in organization with filtering options (admin or compliance officer only)

`spark-admin:recordings_read`

Delete Recording (Admin)`webex_delete_recording_admin`

Permanently delete a recording by ID (admin only, cannot be recovered)

`spark-admin:recordings_write`

Get Attachment Action Details`webex_get_attachment_action_details`

Shows details for an attachment action by ID

`spark:messages_read`

Create Attachment Action`webex_create_attachment_action`

Create a new attachment action

`spark:messages_write`

List Compliance Events (Slido Secure Premium)`webex_list_compliance_events`

List events from a Slido Secure Premium session (polls, answers, Q\&A actions)

`spark-compliance:events_read`

List Hybrid Clusters`webex_list_hybrid_clusters`

List hybrid clusters for an organization (requires administrator privileges)

`spark-admin:hybrid_clusters_read`

Get Hybrid Cluster Details`webex_get_hybrid_cluster_details`

Shows details for a hybrid cluster by ID

`spark-admin:hybrid_clusters_read`

List Hybrid Connectors`webex_list_hybrid_connectors`

List hybrid connectors for an organization (requires administrator privileges)

`spark-admin:hybrid_connectors_read`

Get Hybrid Connector Details`webex_get_hybrid_connector_details`

Shows details for a hybrid connector by ID

`spark-admin:hybrid_connectors_read`

Get Unified Credentials`webex_unified_get_me`

Get the current Webex connection's unified credentials and identity.

`spark:people_read`

IAM Auth Test`webex_auth_test`

Validate the current OAuth token by calling GET /people/me and returning the raw, unmapped Webex person JSON. Use for de...

`spark:people_read`

List Unified Groups`webex_unified_list_groups`

List unified groups in Webex.

`spark:teams_read`

Get Unified Group`webex_unified_get_group`

Get a unified Webex group by ID.

`spark:teams_read`

List Unified Organizations`webex_unified_list_organizations`

List unified organizations in Webex.

`spark-admin:organizations_read`

Get Unified Organization`webex_unified_get_organization`

Get a unified Webex organization by ID.

`spark-admin:organizations_read`

List Unified Resource Types`webex_unified_list_resource_types`

List unified resource types in Webex.

`spark:people_read`

List Unified Resource Users`webex_unified_list_resource_users`

List unified resource users in Webex.

`spark:team_memberships_read`

List Unified Roles`webex_unified_list_roles`

List unified roles in Webex.

`spark-admin:roles_read`

Get Unified Role`webex_unified_get_role`

Get a unified Webex role by ID.

`spark-admin:roles_read`

List Unified Users`webex_unified_list_users`

List unified users in Webex.

`spark-admin:people_read`

Get Unified User`webex_unified_get_user`

Get a unified Webex user by ID.

`spark:people_read`

List Locations`webex_list_locations`

List locations for an organization (requires administrator privileges)

`spark-admin:locations_read`

Get Location Details`webex_get_location_details`

Shows details for a location by ID

`spark-admin:locations_read`

Create Location`webex_create_location`

Create a new location for a given organization

`spark-admin:locations_write`

Update Location`webex_update_location`

Update details for a location by ID

`spark-admin:locations_write`

Delete Location`webex_delete_location`

Delete a location by ID

`spark-admin:locations_write`

List Meeting Participants`webex_list_meeting_participants`

List all participants in an in-progress meeting or an ended meeting

`meeting:participants_read``meeting:admin_participants_read`

Get Meeting Participant Details`webex_get_meeting_participant_details`

Get a meeting participant details of a live or post meeting

`meeting:participants_read``meeting:admin_participants_read`

Update Meeting Participant`webex_update_meeting_participant`

Mute, un-mute, expel, or admit a participant in a live meeting

`meeting:participants_write`

Get Meeting Preferences`webex_get_meeting_preferences`

Retrieves meeting preferences for the authenticated user

`meeting:preferences_read``meeting:admin_preferences_read`

Get Personal Meeting Room Options`webex_get_personal_meeting_room_options`

Retrieves the Personal Meeting Room options for the authenticated user

`meeting:preferences_read``meeting:admin_preferences_read`

Update Personal Meeting Room Options`webex_update_personal_meeting_room_options`

Updates Personal Meeting Room options for the authenticated user

`meeting:preferences_write``meeting:admin_preferences_write`

Get Scheduling Options`webex_get_scheduling_options`

Retrieves scheduling options for the authenticated user

`meeting:preferences_read``meeting:admin_preferences_read`

Get Meeting Qualities`webex_get_meeting_qualities`

Get quality data for a meeting by meetingId (Admin only)

`analytics:read_all`

List Meeting Invitees`webex_list_meeting_invitees`

List invitees for a specific meeting

`meeting:schedules_read``meeting:admin_schedule_read`

Get Meeting Invitee`webex_get_meeting_invitee`

Retrieve details for a meeting invitee by ID

`meeting:schedules_read``meeting:admin_schedule_read`

Create Meeting Invitee`webex_create_meeting_invitee`

Add an invitee to a scheduled meeting

`meeting:schedules_write``meeting:admin_schedule_write`

Update Meeting Invitee`webex_update_meeting_invitee`

Update details for a meeting invitee by ID

`meeting:schedules_write``meeting:admin_schedule_write`

Delete Meeting Invitee`webex_delete_meeting_invitee`

Remove a meeting invitee by ID

`meeting:schedules_write``meeting:admin_schedule_write`

List Meeting Sites`webex_list_meeting_sites`

Retrieve the list of Webex sites that the authenticated user is set up to use

`meeting:admin_config_read`

List Meeting Transcripts`webex_list_meeting_transcripts`

Lists available transcripts of an ended meeting instance

`meeting:transcripts_read``meeting:admin_transcripts_read`

Download Meeting Transcript`webex_download_meeting_transcript`

Download a meeting transcript from the meeting transcript specified by transcriptId

`meeting:transcripts_read``meeting:admin_transcripts_read`

List Transcript Snippets`webex_list_transcript_snippets`

Lists snippets of a meeting transcript specified by transcriptId

`meeting:transcripts_read``meeting:admin_transcripts_read`

List Meetings`webex_list_meetings`

Retrieves details for meetings with filtering options (meeting number, web link, meeting type, etc.)

`meeting:schedules_read``meeting:admin_schedule_read`

Get Meeting Details`webex_get_meeting_details`

Retrieves details for a meeting with a specified meeting ID

`meeting:schedules_read``meeting:admin_schedule_read`

Create Meeting`webex_create_meeting`

Schedule a new meeting, webinar, or personal room meeting with comprehensive configuration options

`meeting:schedules_write``meeting:admin_schedule_write`

Update Meeting`webex_update_meeting`

Update an existing meeting, webinar, or meeting series with modified configuration settings

`meeting:schedules_write``meeting:admin_schedule_write`

Delete Meeting`webex_delete_meeting`

Cancel a scheduled meeting

`meeting:schedules_write``meeting:admin_schedule_write`

List Recordings`webex_list_recordings`

List recordings for meetings

`spark:recordings_read``meeting:admin_recordings_read`

Get Recording Details`webex_get_recording_details`

Get details of a specific recording

`spark:recordings_read``meeting:admin_recordings_read`

Delete Recording`webex_delete_recording`

Delete a meeting recording

`spark:recordings_write``meeting:admin_recordings_write`

List Memberships`webex_list_memberships`

List all room memberships with filtering options for rooms and persons

`spark:memberships_read`

Get Membership Details`webex_get_membership_details`

Get details of a specific membership by ID

`spark:memberships_read`

Create Membership`webex_create_membership`

Add someone to a room by Person ID or email address, optionally making them a moderator

`spark:memberships_write`

Update Membership`webex_update_membership`

Update membership properties including moderator status and room visibility

`spark:memberships_write`

Delete Membership`webex_delete_membership`

Deletes a membership by ID to remove a person from a room

`spark:memberships_write`

List Team Memberships`webex_list_team_memberships`

Lists all team memberships for a given team

`spark:team_memberships_read`

Get Team Membership Details`webex_get_team_membership_details`

Shows details for a team membership, by ID

`spark:team_memberships_read`

Create Team Membership`webex_create_team_membership`

Add someone to a team by Person ID or email address, optionally making them a moderator

`spark:team_memberships_write`

Update Team Membership`webex_update_team_membership`

Updates a team membership, by ID

`spark:team_memberships_write`

Delete Team Membership`webex_delete_team_membership`

Deletes a team membership, by ID

`spark:team_memberships_write`

List Messages`webex_list_messages`

Lists all messages in a room with content attachments if present

`spark:messages_read`

Get Message Details`webex_get_message_details`

Show details for a message, by message ID

`spark:messages_read`

Create Message`webex_create_message`

Post a plain text or rich text message, and optionally, a file attachment, to a room

`spark:messages_write`

Update Message`webex_update_message`

Edit a message you have posted not more than 10 times

`spark:messages_write`

Delete Message`webex_delete_message`

Delete a message, by message ID

`spark:messages_write`

List Organizations`webex_list_organizations`

List all organizations visible by your account

`spark:organizations_read`

Get Organization Details`webex_get_organization_details`

Shows details for an organization, by ID

`spark:organizations_read`

List Licenses`webex_list_licenses`

List all licenses for a given organization

`spark-admin:licenses_read`

Get License Details`webex_get_license_details`

Shows details for a license, by ID

`spark-admin:licenses_read`

List Roles`webex_list_roles`

List all roles

`spark-admin:roles_read`

Get Role Details`webex_get_role_details`

Shows details for a role, by ID

`spark-admin:roles_read`

List Events`webex_list_events`

List events in your organization with filtering options

`spark-admin:organizations_read`

Get Event Details`webex_get_event_details`

Shows details for an event, by event ID

`spark-admin:organizations_read`

List Devices`webex_list_devices`

List devices (Webex room devices, phones) in organization

`spark-admin:devices_read`

Get Device Details`webex_get_device_details`

Shows details for a device, by ID

`spark-admin:devices_read`

Create Device By MAC Address`webex_create_device`

Create a new device by its MAC address

`spark-admin:devices_write`

Delete Device`webex_delete_device`

Delete a device by ID

`spark-admin:devices_write`

List People`webex_list_people`

List people in your organization. For non-admin users, at least one filter parameter (email, displayName, roles, or id)...

`spark:people_read`

Get Person Details`webex_get_person_details`

Shows details for a person, by ID

`spark:people_read`

Get My Details`webex_get_my_details`

Get profile details for the authenticated user

`spark:people_read`

Create Person`webex_create_person`

Create a new user account for a given organization (only an admin can create a new user account)

`spark-admin:people_write`

Update Person`webex_update_person`

Full update of a person's details by ID (only admin can update person details - requires all user fields to prevent data...

`spark-admin:people_write`

Delete Person`webex_delete_person`

Remove a person from the system

`spark-admin:people_write`

List Report Templates`webex_list_report_templates`

List all the available report templates that can be generated

`spark-admin:reports_read`

List Reports`webex_list_reports`

Lists all reports with optional query parameters for filtering

`spark-admin:reports_read`

Get Report Details`webex_get_report_details`

Shows details for a report, by report ID

`spark-admin:reports_read`

Create Report`webex_create_report`

Create a new report from a template

`spark-admin:reports_write`

Delete Report`webex_delete_report`

Remove a report from the system

`spark-admin:reports_write`

List Resource Groups`webex_list_resource_groups`

List resource groups with optional query parameters for filtering (requires administrator privileges)

`spark-admin:resource_groups_read`

Get Resource Group Details`webex_get_resource_group_details`

Shows details for a resource group, by ID

`spark-admin:resource_groups_read`

List Resource Group Memberships`webex_list_resource_group_memberships`

Lists all resource group memberships for an organization

`spark-admin:resource_group_memberships_read`

Get Resource Group Membership Details`webex_get_resource_group_membership_details`

Shows details for a resource group membership, by ID

`spark-admin:resource_group_memberships_read`

Update Resource Group Membership`webex_update_resource_group_membership`

Updates a resource group membership by ID

`spark-admin:resource_group_memberships_write`

List Rooms`webex_list_rooms`

List rooms to which the authenticated user belongs to

`spark:rooms_read`

Get Room Details`webex_get_room_details`

Shows details for a room, by ID

`spark:rooms_read`

Create Room`webex_create_room`

Creates a room (authenticated user is automatically added as a member)

`spark:rooms_write`

Update Room`webex_update_room`

Updates details for a room, by ID

`spark:rooms_write`

Delete Room`webex_delete_room`

Deletes a room, by ID (deleted rooms cannot be recovered)

`spark:rooms_write`

List Teams`webex_list_teams`

Lists teams to which the authenticated user belongs

`spark:teams_read`

Get Team Details`webex_get_team_details`

Shows details for a team, by ID

`spark:teams_read`

Create Team`webex_create_team`

Creates a team (authenticated user is automatically added as a member)

`spark:teams_write`

Update Team`webex_update_team`

Updates details for a team, by ID

`spark:teams_write`

Delete Team`webex_delete_team`

Deletes a team, by ID

`spark:teams_write`

List Workspaces`webex_list_workspaces`

List workspaces with extensive filtering options (requires administrator privileges)

`spark-admin:workspaces_read`

Get Workspace Details`webex_get_workspace_details`

Shows details for a workspace, by ID

`spark-admin:workspaces_read`

Create Workspace`webex_create_workspace`

Create a new workspace

`spark-admin:workspaces_write``spark-admin:telephony_config_write`

Update Workspace`webex_update_workspace`

Update details for a workspace by ID

`spark-admin:workspaces_write``spark-admin:telephony_config_write`

Delete Workspace`webex_delete_workspace`

Deletes a workspace by ID

`spark-admin:workspaces_write``spark-admin:telephony_config_write`

List Webhooks`webex_list_webhooks`

List all of your webhooks

`spark:webhooks_read`

Get Webhook Details`webex_get_webhook_details`

Shows details for a webhook, by ID

`spark:webhooks_read`

Create Webhook`webex_create_webhook`

Creates a webhook

`spark:webhooks_write`

Update Webhook`webex_update_webhook`

Updates a webhook, by ID

`spark:webhooks_write`

Delete Webhook`webex_delete_webhook`

Deletes a webhook, by ID

`spark:webhooks_write`

## Events

Tags

Select all
|
Clear

Attachments

Calls

Health Checks

Meetings

Memberships

Messages

Participants

Recordings

Rooms

Transcripts

No tags found

27 events

EventDescriptionTags

Active Check`webex_active_check`

Responds with 200 OK to any Webex webhook delivery that does not carry a recognized resource and event pair.

Health Checks

Message Created`webex_webhook_message_created`

Fired when a new message is posted into a room the authorizing user or bot is a member of.

Messages

Message Deleted`webex_webhook_message_deleted`

Fired when a message is deleted from a room the authorizing user or bot is a member of.

Messages

Room Created`webex_webhook_room_created`

Fired when a new room (space) is created by the authorizing user or one of their integrations.

Rooms

Room Updated`webex_webhook_room_updated`

Fired when a room the authorizing user is in is updated, most often when it is locked or unlocked.

Rooms

Room Migrated`webex_webhook_room_migrated`

Fired when a room the authorizing user or bot is in is migrated to a different geography.

Rooms

Membership Created`webex_webhook_membership_created`

Fired when someone joins a room the authorizing user is in, or the authorizing user is added to a new room.

Memberships

Membership Updated`webex_webhook_membership_updated`

Fired when a membership changes in a room the authorizing user is in, primarily to signal moderator changes.

Memberships

Membership Deleted`webex_webhook_membership_deleted`

Fired when someone leaves or is removed from a group room the authorizing user is in.

Memberships

Card Action Submitted`webex_webhook_attachment_action_created`

Fired when a user submits an adaptive card the authorizing bot or integration posted.

Attachments

Meeting Created`webex_webhook_meeting_created`

Fired when a new meeting is scheduled.

Meetings

Meeting Updated`webex_webhook_meeting_updated`

Fired when a scheduled meeting is modified.

Meetings

Meeting Deleted`webex_webhook_meeting_deleted`

Fired when a scheduled meeting is cancelled or deleted.

Meetings

Meeting Started`webex_webhook_meeting_started`

Fired when a scheduled meeting actually starts.

Meetings

Meeting Ended`webex_webhook_meeting_ended`

Fired when a live meeting ends.

Meetings

Meeting Participant Joined`webex_webhook_meeting_participant_joined`

Fired when a participant joins a meeting.

Participants

Meeting Participant Left`webex_webhook_meeting_participant_left`

Fired when a participant leaves a meeting.

Participants

Meeting Transcript Created`webex_webhook_meeting_transcript_created`

Fired when a transcript becomes available for a recorded meeting.

Transcripts

Recording Created`webex_webhook_recording_created`

Fired when a new meeting recording becomes available.

Recordings

Recording Updated`webex_webhook_recording_updated`

Fired when an existing meeting recording is modified.

Recordings

Recording Deleted`webex_webhook_recording_deleted`

Fired when a meeting recording is permanently deleted.

Recordings

Converged Recording Created`webex_webhook_converged_recording_created`

Fired when a new converged (call) recording becomes available.

Recordings

Converged Recording Updated`webex_webhook_converged_recording_updated`

Fired when an existing converged (call) recording is modified.

Recordings

Converged Recording Deleted`webex_webhook_converged_recording_deleted`

Fired when a converged (call) recording is deleted.

Recordings

Call Started`webex_webhook_call_created`

Fired when the authorizing user originates or receives a call.

Calls

Call Updated`webex_webhook_call_updated`

Fired when a call the authorizing user is on changes state.

Calls

Call Ended`webex_webhook_call_deleted`

Fired when a call the authorizing user was on is disconnected.

Calls


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.