{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-subscription-request-schema.json",
  "title": "SubscriptionRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-agent-wellbeing-api-openapi.yml#/components/schemas/SubscriptionRequest",
  "required": [
    "destinationUrl",
    "eventTypes",
    "name"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 64,
      "minLength": 4,
      "type": "string",
      "description": "Client-defined string naming the subscription."
    },
    "description": {
      "maxLength": 1024,
      "minLength": 0,
      "type": "string",
      "description": "Client-defined string describing the subscription."
    },
    "eventTypes": {
      "maxItems": 32,
      "minItems": 1,
      "type": "array",
      "description": "Types of events to which the subscription will listen.",
      "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"
    },
    "secret": {
      "maxLength": 256,
      "minLength": 32,
      "type": "string",
      "description": "Secret string used to sign payloads sent to the destination URL."
    },
    "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"
    }
  }
}