Away 11:54 PM

2 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_Payload — openapi

Details about the notification.

Properties

NameTypeRequiredDescription
typestringfalseThe type of notification. Possible values: | Value | Description | | --- | --- | | TYPE_UNSPECIFIED | The default value. This value is unused. | | MOMENT | A notification type representing a moment. |
messageIdstringfalseAn ID that represents a customizable notification message template that you create in Creator Dashboard. The message can contain customizable parameters that you can specify values for. For example, Your {egg_name} just hatched has an egg_name parameter. See the parameters field for more information.
parametersobjectfalseA map of parameters used to render a notification message template. For example, given a template of Your {egg_name} just hatched. with parameters of [{"egg_name": {"string_value": "royal egg"}}], the rendered notification message is: Your royal egg just hatched.
joinExperience#/components/schemas/UserNotification_Payload_JoinExperiencefalseCall-to-action that represents joining an experience.
analyticsData#/components/schemas/UserNotification_Payload_AnalyticsDatafalseData for how analytics are reported.

Complete Schema

{
  "type": "object",
  "properties": {
    "type": {
      "writeOnly": true,
      "example": "TYPE_UNSPECIFIED",
      "enum": [
        "TYPE_UNSPECIFIED",
        "MOMENT"
      ],
      "type": "string",
      "description": "The type of notification.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | TYPE_UNSPECIFIED | The default value. This value is unused. |\n  | MOMENT | A notification type representing a moment. |",
      "format": "enum"
    },
    "messageId": {
      "writeOnly": true,
      "example": "5dd7024b-68e3-ac4d-8232-4217f86ca244",
      "type": "string",
      "description": "An ID that represents a customizable notification message template\nthat you create in Creator Dashboard.\n\nThe message can contain customizable parameters that you can specify\nvalues for. For example, `Your {egg_name} just hatched` has an\n`egg_name` parameter. See the `parameters` field for more\ninformation."
    },
    "parameters": {
      "writeOnly": true,
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/UserNotification_Payload_ParameterValue"
      },
      "description": "A map of parameters used to render a notification message template.\n\nFor example, given a template of `Your {egg_name} just hatched.` with\nparameters of `[{\"egg_name\": {\"string_value\": \"royal egg\"}}]`, the\nrendered notification message is: `Your royal egg just hatched.`"
    },
    "joinExperience": {
      "$ref": "#/components/schemas/UserNotification_Payload_JoinExperience",
      "description": "Call-to-action that represents joining an experience."
    },
    "analyticsData": {
      "$ref": "#/components/schemas/UserNotification_Payload_AnalyticsData",
      "description": "Data for how analytics are reported."
    }
  },
  "description": "Details about the notification.",
  "x-oneOf": {
    "callToAction": [
      "joinExperience"
    ]
  }
}