1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

UserNotification — cloud.docs

Represents a notification sent to a user.

Properties

Related Schemas

• UserNotification_Source

• UserNotification_Payload

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "users/123/notifications/01234567-ABCD-1234-ABCD-0123456789AB",
      "type": "string",
      "description": "The resource path of the user notification.\n\nFormat: `users/{user_id}/notifications/{user_notification_id}`"
    },
    "id": {
      "readOnly": true,
      "example": "a6746f2e-2cc6-11ee-be56-0242ac120002",
      "type": "string",
      "description": "A unique UUID of the user notification."
    },
    "source": {
      "$ref": "#/components/schemas/UserNotification_Source",
      "description": "The source of the notification."
    },
    "payload": {
      "$ref": "#/components/schemas/UserNotification_Payload",
      "description": "The notification payload."
    }
  },
  "description": "Represents a notification sent to a user.",
  "x-aep-resource": {
    "patterns": [
      "users/{user_id}/notifications/{user_notification_id}"
    ],
    "plural": "user-notifications",
    "singular": "user-notification"
  },
  "x-resource": true
}