Webex Service App
March 2, 2024 by Eric Gerhardt
Summary
This Webex App is created in the client’s Webex environment to connect Webex products that are being managed by PPI under a service contract. This app is owned by the client administrator and can be edited, deactivated, or deleted at any time.
The goal of collecting this data is to present metrics and data for the client in a consolidated format in the PPI Vantage App. Having this Webex information will also enable our service team to better support the client and their AV infrastructure.
What are monitoring?
Vantage will highlight Device Connection Statuses, Issues, and Error Codes as the main attributes in its dashboards and tables. Details about the data collected by Vantage can be found in the Webex scopes defined below.
Creating the App
Information on how to create a Server App can be found in their developer portal.
In order to authenticate from our end to the Server App PPI needs the apps:
- Client ID
- Client Secret
- Refresh Token
- Access Token
OAuth Tokens
The minimum TTL setting that Webex allows for access tokens is 6 hours. We have scheduled our server to update tokens within that window. If there are issues with either of the tokens refer to the organization settings in the admin portal.
Scopes
Scopes define the API methods the app is allowed to call. All information regarding the different Webex scopes can be found in their developer portal. The Webex scopes required of Vantage are:
Devices
These scopes include information about your Webex devices including their locations, and health.
- Scopes:
spark:devices_readspark-admin:devices_read
- Endpoints:
Locations and Workspaces
These scopes include location and workspace information that is used by users to filter the data with the app.
- Scopes:
spark-admin:locations_readspark-admin:workspaces_readspark-admin:workspace_metrics_read
- Endpoints:
Activation
After the app is created it needs to be authorized by an admin in the admin portal.