{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/SubscriptionResponse", "title": "SubscriptionResponse", "required": [ "createdBy", "createdTime", "destinationUrl", "eventTypes", "id", "lastUpdatedBy", "lastUpdatedTime", "name", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Subscription ID.", "format": "uuid", "example": "41e92806-331d-4802-bc12-674f92d4a6f7" }, "name": { "maxLength": 64, "minLength": 4, "type": "string", "description": "Client-defined string naming the subscription.", "example": "My Integration's Subscription" }, "description": { "maxLength": 1024, "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": { "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/" }, "createdTime": { "type": "integer", "description": "Time when subscription was created (epoch milliseconds).", "format": "int64", "example": 1591702170000 }, "createdBy": { "type": "string", "description": "Email address of the user who created the subscription.", "format": "email", "example": "example@example.com" }, "status": { "type": "string", "description": "Status of the subscription. Can be \"active\" or \"inactive\". The system may change the status to \"inactive\" in error scenarios.", "example": "active", "enum": [ "active", "inactive" ] }, "lastUpdatedTime": { "type": "integer", "description": "Time when the subscription was last updated (epoch milliseconds).", "format": "int64", "example": 1591702170000 }, "lastUpdatedBy": { "type": "string", "description": "Email address of the user who updated the subscription most recently.", "format": "email", "example": "example@example.com" } } }