The resource path of the user notification.
Format: users/{user_id}/notifications/{user_notification_id}.
UserNotification
Represents a notification sent to a user.
Attributes
A unique UUID of the user notification.
The source of the notification.
The notification payload.
Base URL
https://apis.roblox.comThe UserNotification Resource
{
"path": "users/123/notifications/01234567-ABCD-1234-ABCD-0123456789AB",
"id": "a6746f2e-2cc6-11ee-be56-0242ac120002",
"source": {
"universe": "universes/96623001"
},
"payload": {
"type": "TYPE_UNSPECIFIED",
"messageId": "5dd7024b-68e3-ac4d-8232-4217f86ca244",
"parameters": {
"key": {
"stringValue": "bronze egg"
}
},
"joinExperience": {
"launchData": "Launch Data"
},
"analyticsData": {
"category": "Bronze egg hatched"
}
}
}UserNotification
Create User Notification
POST /cloud/v2/users/{user_id}/notifications
Sends a notification to a user.
user.user-notification:write
RequestPath ParametersThe user ID.
ResponseUserNotification
POST /cloud/v2/users/{user_id}/notifications
curl -L -X POST 'https://apis.roblox.com/cloud/v2/users/{user_id}/notifications' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"source": {
"universe": "universes/96623001"
},
"payload": {
"type": "TYPE_UNSPECIFIED",
"messageId": "5dd7024b-68e3-ac4d-8232-4217f86ca244",
"parameters": {
"key": {
"stringValue": "bronze egg"
}
},
"joinExperience": {
"launchData": "Launch Data"
},
"analyticsData": {
"category": "Bronze egg hatched"
}
}
}'Response
{
"path": "users/123/notifications/01234567-ABCD-1234-ABCD-0123456789AB",
"id": "a6746f2e-2cc6-11ee-be56-0242ac120002"
}