Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webex Agent Wellbeing API

The Agent Wellbeing API from Webex — 4 operation(s) for agent wellbeing.

Webex Agent Wellbeing API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agent Wellbeing. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

5 operations 4 paths 9 schemas 2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Agent Wellbeing API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Agent Wellbeing 5
POST
/v1/agentburnout/subscribe
Subscribe for realtime burnout events
subscribe_agentburnout 1 param body → 200400401403429500
POST
/v1/agentburnout/action
Record the realtime burnout events
post_action 1 param body → 200400401403429500
GET
/organization/{orgid}/agent-burnout/{id}deprecated
Get specific Agent Burnout resource by ID
getConfigAgentBurnout 2 params → 200401403404429500
PUT
/organization/{orgid}/agent-burnout/{id}deprecated
Update specific Agent Burnout resource by ID
updateConfigAgentBurnout 2 params body → 200400401403404412429500
GET
/organization/{orgid}/v2/agent-burnoutdeprecated
List Agent Burnout resource(s)
getAllConfigWithMetaDataAgentBurnout 5 params → 200401403404429500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SubscriptionResponse (10 properties), AgentBurnoutDTO (8 properties), SubscriptionRequest (6 properties), MetaDataWithPagingInfo (6 properties). Each schema is shown below with its type and property counts.

ApiErrorResponse
object
Response body for an API error.
2 properties
ActionRequest
object
5 properties
SubscriptionResponse
object
10 properties 9 required
ErrorDetails
object
Details of an error.
2 properties
ActionResponse
object
2 properties
AgentBurnoutDTO
object
8 properties 2 required
OperationError
object
An error message providing details about the operation failure.
1 property
SubscriptionRequest
object
6 properties 3 required
MetaDataWithPagingInfo
object
Metadata of response with paging information
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-agent-wellbeing-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
Webex Admin Audit Events API
Webex Agent Personal Greeting Files API
Webex Agent Summaries API
Webex Agents API
Webex AI Feature API
Webex API - Domain Management API
Webex Archive Users API
Webex Attachment Actions API
Webex Audio Files API
Webex Authorizations API
Webex Auto CSAT API