Cloud

UserNotification

Attributes

pathstring

idstring

sourceobject

payloadobject

Base URL

https://apis.roblox.com/cloud
The UserNotification Resource

{
"path": "users/1/notifications/a6746f2e-2cc6-11ee-be56-0242ac120002",
"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"
}
}
}

Create User Notification

POST /v2/users/{user}/notifications
Scopes
user.user-notification:write
RequestPath Parameters
userstringRequired

Request BodyUserNotification
POST /v2/users/{user}/notifications

curl --include --location -X POST "https://apis.roblox.com/cloud/v2/users/{user}/notifications" \
--header "x-api-key: <api-key>" \
-d '{ \
"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/1/notifications/a6746f2e-2cc6-11ee-be56-0242ac120002",
"id": "a6746f2e-2cc6-11ee-be56-0242ac120002"
}