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 Subscriptions API

The Subscriptions API from Webex — 6 operation(s) for subscriptions.

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

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

This API exposes 12 operations across 6 paths, and defines 22 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

12 operations 6 paths 22 schemas 2 DELETE6 GET2 PATCH2 POST

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 Subscriptions 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 12

Across 6 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 12
GET
/v1/subscriptions
List Subscriptions
getSubscriptionByOrgId 2 params → 200400401403500
POST
/v1/subscriptions
Register Subscription
createSubscription 1 param body → 201400401403500
GET
/v1/subscriptions/{id}
Get Subscription
getSubscriptionById 3 params → 200400401403500
DELETE
/v1/subscriptions/{id}
Delete Subscription
deleteSubscriptionById 3 params → 204400401403500
PATCH
/v1/subscriptions/{id}
Update Subscription
updateSubscriptionById 2 params body → 200400401403500
GET
/v1/event-types
List Event Types
getAllEventTypes 2 params → 200400401403500
GET
/v2/subscriptions
List Subscriptions
getSubscriptionByOrgIdV2 2 params → 200400401403500
POST
/v2/subscriptions
Register Subscription
createSubscriptionWithV2 1 param body → 201400401403500
GET
/v2/subscriptions/{id}
Get Subscription
getSubscriptionByIdV2 3 params → 200400401403500
DELETE
/v2/subscriptions/{id}
Delete Subscription
deleteSubscriptionByIdV2 3 params → 204400401403500
PATCH
/v2/subscriptions/{id}
Update Subscription
updateSubscriptionByIdWithV2 2 params body → 200400401403500
GET
/v2/event-types
List Event Types
getAllEventTypesWithResourceVersionMetadata 2 params → 200400401403500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SubscriptionResponseEnhanced (11 properties), SubscriptionResponse (10 properties), SubscriptionRequestUpdateEnhanced (7 properties), SubscriptionRequestEnhanced (7 properties). Each schema is shown below with its type and property counts.

MetaResourceVersionInfo
object
2 properties 1 required
MetaSubInfo
object
1 property
SubscriptionResponseEnhanced
object
11 properties 10 required
SubscriptionApiListResponseEnhanced
object
2 properties 2 required
Meta
object
Response metadata.
1 property
Error
object
2 properties 1 required
SubscriptionApiResponseEnhanced
object
2 properties
SubscriptionCreateApiResponseEnhanced
object
2 properties
SubscriptionApiListResponse
object
2 properties 2 required
ResourceVersion
object
List of all resources, and it's supported versions available to subscribe.
2 properties
EventTypesApiListResponseEnhanced
object
2 properties 2 required
SubscriptionRequestUpdateEnhanced
object
7 properties 1 required
SubscriptionCreateApiResponse
object
2 properties
SubscriptionResponse
object
10 properties 9 required
EventTypesApiListResponse
object
2 properties 2 required
ErrorResult
object
2 properties 1 required
FieldValidationError
object
1 property 1 required
SubscriptionApiResponse
object
2 properties
EventTypesResponse
object
3 properties 3 required
SubscriptionRequest
object
6 properties 3 required
SubscriptionRequestUpdate
object
6 properties
SubscriptionRequestEnhanced
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-subscriptions-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 Agent Wellbeing 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