Skip to main content
A Full Admin of your Webex organization must authorize the Service App in Control Hub. Read-only and device admins cannot authorize it.

Setting up a Webex Service App

A Service App calls Webex as a machine account in your organization, so the connection keeps working when any one user leaves. You need its Client ID, Client Secret and a refresh token for your organization.

1

Sign in to Webex for Developers

Sign in to your Webex for Developers account with the Webex account that will own the Service App.

  • Enter your Email and Password.
  • Click Sign In.
Webex sign-in
2

Create a new app

Click your profile avatar in the top-right corner, then select My Webex Apps.

  • Click Create New App.
My Webex Apps
3

Choose the Service App type

On What would you like to configure?, find the Service App card.

  • Click Onboard Service App.
Onboard Service App
4

Fill in the app details

Complete the New Service App form. Admins see these details in Control Hub when they authorize the app.

  • App name: the name your Service App shows in Webex
  • Icon: upload your own or keep a default
  • Description: what the app does and how your organization uses it
  • Contact Email: the email address admins can contact about the app
New Service App form
5

Select the scopes

Enables actions: Create Device By MAC Address, Create Location, Create Meeting, Create Meeting Invitee, Create Person, Create Workspace, Delete Device, Delete Location, Delete Meeting, Delete Meeting Invitee, Delete Person, Delete Recording, Delete Recording (Admin), Delete Workspace, Download Meeting Transcript, Get Device Details, Get Event Details, Get Hybrid Cluster Details, Get Hybrid Connector Details, Get License Details, Get Location Details, Get Meeting Details, Get Meeting Invitee, Get Meeting Participant Details, Get Meeting Preferences, Get Personal Meeting Room Options, Get Recording Details, Get Resource Group Details, Get Resource Group Membership Details, Get Role Details, Get Scheduling Options, Get Unified Organization, Get Unified Role, Get Workspace Details, List Admin Audit Events, List Compliance Events (Slido Secure Premium), List Devices, List Events, List Hybrid Clusters, List Hybrid Connectors, List Licenses, List Locations, List Meeting Invitees, List Meeting Participants, List Meeting Sites, List Meeting Transcripts, List Meetings, List Recordings, List Recordings (Admin/Compliance Officer), List Resource Group Memberships, List Resource Groups, List Roles, List Transcript Snippets, List Unified Organizations, List Unified Roles, List Unified Users, List Workspaces, Update Location, Update Meeting, Update Meeting Invitee, Update Person, Update Personal Meeting Room Options, Update Resource Group Membership, Update Workspace

In Scopes on the same form, select the scopes the connector’s actions need, then create the app. Request only these, so the admin can see exactly what access the app is granted.

  • Scopes starting with spark-compliance: need a Full Admin who also has the Compliance Officer role to authorize the app.
  • Scopes starting with meeting:admin_ need a Webex Meetings site in your organization. Without one, Control Hub cannot authorize the app, so leave these scopes out if your organization has no Webex Meetings subscription. The meeting actions then do not work with this connection.
6

Copy the client credentials

The app’s page opens after it is created. Under Authorization, it shows the Client ID and Client Secret.

  • Click Copy next to the Client ID and paste it into the Client ID field when you connect your account.
  • Copy the Client Secret and paste it into the Client Secret field when you connect your account.
  • The Client Secret is shown only once. If you lose it, click Regenerate the client secret on the app’s page.
Service App credentials
7

Request admin authorization

On the app’s page, click Request Admin Authorization. Under Admin Authorization, the Submission Status changes to Submitted, and the app appears in your organization’s Control Hub, where a Full Admin can authorize it.

Authorizing the Service App

A Full Admin of your organization authorizes the app in Control Hub. Other admin roles do not see Apps in Control Hub.

1

Authorize the app

Sign in to your organization’s Webex Control Hub as a Full Admin, then go to Management > Apps.

  • Open the Service Apps tab, then Other service apps.
  • Click your Service App to review its description and requested scopes.
  • Turn on Authorized. If the toggle is locked, the app requests meeting:admin_ scopes and your organization has no Webex Meetings site.
  • Click Save.
Authorize Service App

Find your refresh token

After the app is authorized, retrieve the token pair for your organization from the Service App’s page in My Webex Apps.

1

Copy the refresh token

In the Org Authorizations section, select your organization from the drop-down list.

  • Paste the app’s Client Secret into the field provided. This is the secret you copied when you registered the app; if you no longer have it, regenerate it on the app’s page.
  • Retrieve the access and refresh tokens.
  • Copy the refresh token and paste it into the Refresh Token field when you connect your account.
  • Webex renews the refresh token each time it is used. Retrieve a new one if an admin authorizes the app again or its scopes change.
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Next Steps

Webhooks setup

Configure receiving Events for Webex into StackOne.