Webex · Schema

SubscriptionRequestEnhanced

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	Client-defined string naming the subscription.
description	string	Client-defined string describing the subscription.
eventTypes	array	Types of events to which the subscription will listen.
destinationUrl	string	URL to which webhooks will be posted. Must be HTTPS on an IANA-listed top-level domain name (e.g. .com) with a path (at least /). No query parameters, userinfo, non-443 ports, or fragments allowed. We
secret	string	Secret string used to sign payloads sent to the destination URL.
orgId	string	Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permission to interact with the organization.
resourceVersion	string	Represents version of the resource client is interested in. Should be of the format ‘resource:version’. Refer to the List Event Types V2 API for details on the latest available resources and versions.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SubscriptionRequestEnhanced",
  "title": "SubscriptionRequestEnhanced",
  "required": [
    "destinationUrl",
    "eventTypes",
    "name",
    "resourceVersion"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 64,
      "minLength": 4,
      "type": "string",
      "description": "Client-defined string naming the subscription.",
      "example": "My Integration's Subscription"
    },
    "description": {
      "maxLength": 1024,
      "minLength": 0,
      "type": "string",
      "description": "Client-defined string describing the subscription.",
      "example": "The subscription my integration uses to synchronize with WxCC"
    },
    "eventTypes": {
      "maxItems": 32,
      "minItems": 1,
      "type": "array",
      "description": "Types of events to which the subscription will listen.",
      "example": [
        "agent:login",
        "agent:logout"
      ],
      "items": {
        "type": "string"
      }
    },
    "destinationUrl": {
      "pattern": "^(https?)://.*$",
      "type": "string",
      "description": "URL to which webhooks will be posted. Must be HTTPS on an IANA-listed top-level domain name (e.g. .com) with a path (at least /). No query parameters, userinfo, non-443 ports, or fragments allowed. We do not treat this field as sensitive data, so do not use secrets in this URL such as tokens or API keys.",
      "format": "uri",
      "example": "https://www.cisco.com/"
    },
    "secret": {
      "maxLength": 256,
      "minLength": 32,
      "type": "string",
      "description": "Secret string used to sign payloads sent to the destination URL.",
      "example": "my-32-plus-character-long-secret"
    },
    "orgId": {
      "type": "string",
      "description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permission to interact with the organization.",
      "format": "uuid",
      "example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
    },
    "resourceVersion": {
      "maxLength": 50,
      "minLength": 1,
      "type": "string",
      "description": "Represents version of the resource client is interested in. Should be of the format \u2018resource:version\u2019. Refer to the List Event Types V2 API for details on the latest available resources and versions.",
      "example": "agent:1.0.0"
    }
  }
}