Acquia · Schema

Notification

A notification about an event or a task.

ContentExperience

Properties

Name	Type	Description
progress	integer	The notification progress.
user	object
uuid	string	The notification unique identifier.
name	string	The notification name.
title	string	The operation title.
description	string	The notification description.
created_at	string	The time that this notification was created.
started_at	string	The time that the task or event this notification is tracking was started at.
completed_at	string	The time that the task or event this notification is tracking was completed at.
status	string	The status of the notification.
type	string	The notification type.
metadata	object	A collection of metadata related to the notification.
labels	object
_links	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/json-schema/acquia-cloud-notification-schema.json",
  "title": "Notification",
  "description": "A notification about an event or a task.",
  "type": "object",
  "properties": {
    "progress": {
      "type": "integer",
      "description": "The notification progress.",
      "minimum": 0,
      "maximum": 100
    },
    "user": {
      "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_user-stub"
    },
    "uuid": {
      "type": "string",
      "description": "The notification unique identifier.",
      "format": "uuid"
    },
    "name": {
      "type": "string",
      "description": "The notification name."
    },
    "title": {
      "type": "string",
      "description": "The operation title."
    },
    "description": {
      "type": "string",
      "description": "The notification description."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time that this notification was created."
    },
    "started_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time that the task or event this notification is tracking was started at."
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time that the task or event this notification is tracking was completed at."
    },
    "status": {
      "type": "string",
      "description": "The status of the notification.",
      "enum": [
        "completed",
        "in-progress",
        "failed"
      ]
    },
    "type": {
      "type": "string",
      "description": "The notification type.",
      "enum": [
        "task",
        "event"
      ]
    },
    "metadata": {
      "type": "object",
      "description": "A collection of metadata related to the notification.",
      "properties": {
        "environments": {
          "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_environment-metadata"
        }
      }
    },
    "labels": {
      "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_notification-labels"
    },
    "_links": {
      "$ref": "#/components/schemas/Acquia_Cloud_API_Documentation_links"
    }
  },
  "required": [
    "progress",
    "user",
    "uuid",
    "name",
    "title",
    "description",
    "created_at",
    "started_at",
    "completed_at",
    "status",
    "type",
    "metadata",
    "labels",
    "_links"
  ]
}