Webex · Schema

WorkItemForm

Work item message payload.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
aliasId string Identifier of the work item message.
workItemData object Structured key-value payload for the work item form. Maximum 50 entries; keys up to 100 UTF-8 bytes, values up to 1024 UTF-8 bytes.
timestamp integer Unix epoch timestamp in milliseconds representing when the work item was originated.
View JSON Schema on GitHub

JSON Schema

webex-workitemform-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WorkItemForm",
  "title": "WorkItemForm",
  "type": "object",
  "description": "Work item message payload.",
  "required": [
    "aliasId",
    "workItemData",
    "timestamp"
  ],
  "properties": {
    "aliasId": {
      "type": "string",
      "description": "Identifier of the work item message.",
      "example": "msg-001"
    },
    "workItemData": {
      "type": "object",
      "description": "Structured key-value payload for the work item form. Maximum 50 entries; keys up to 100 UTF-8 bytes, values up to 1024 UTF-8 bytes.",
      "maxProperties": 50,
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "name": "customer name",
        "email": "[email protected]"
      }
    },
    "timestamp": {
      "type": "integer",
      "format": "int64",
      "description": "Unix epoch timestamp in milliseconds representing when the work item was originated.",
      "example": 1732786800000
    }
  }
}