Notification

A user notification

AuthoringEducationeLearningLMSSCORMTrainingxAPI

Properties

Name	Type	Description
id	string	Unique notification identifier
type	string
attributes	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-schema/prime-api-notification-schema.json",
  "title": "Notification",
  "description": "A user notification",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique notification identifier"
    },
    "type": {
      "type": "string",
      "const": "userNotification"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "actionTaken": {
          "type": "boolean",
          "description": "Whether the user has acted on this notification"
        },
        "channel": {
          "type": "string",
          "description": "Notification delivery channel"
        },
        "dateCreated": {
          "type": "string",
          "format": "date-time",
          "description": "Notification creation timestamp"
        },
        "message": {
          "type": "object",
          "description": "Notification message content"
        },
        "modelType": {
          "type": "string",
          "description": "The type of model this notification relates to"
        },
        "read": {
          "type": "boolean",
          "description": "Whether the notification has been read"
        }
      }
    }
  }
}