Skip to main content

Uniphore Customer Portal

4. Alert Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "sessionId": {
      "type": "string"
    },
    "startTime": {
      "type": "integer"
    },
    "sequenceNumber": {
      "type": "integer"
    },
    "resolved": {
      "type": "boolean"
    },
    "alert": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "recipient": {
          "type": "string"
        },
        "displayCount": {
          "type": "integer"
        }
      },
      "required": [
        "name",
        "message",
        "type",
        "recipient",
        "displayCount"
      ]
    },
    "metadata": {
      "type": "object",
      "properties": {
        "agentId": {
          "type": "string"
        },
        "customerId": {
          "type": "string"
        },
        "agentClientId": {
          "type": "string"
        },
        "customerClientId": {
          "type": "string"
        },
        "contactType": {
          "type": "string"
        },
        "journeyId": {
          "type": "string"
        },
        "tenantId": {
          "type": "string"
        },
        "organizationId": {
          "type": "string"
        },
        "categoryId": {
          "type": "string"
        }
      },
      "required": [
        "agentId",
        "customerId",
        "agentClientId",
        "customerClientId",
        "contactType",
        "journeyId",
        "tenantId",
        "organizationId",
        "categoryId"
      ]
    }
  },
  "required": [
    "id",
    "sessionId",
    "startTime",
    "sequenceNumber",
    "resolved",
    "alert",
    "metadata"
  ]
}