UserNotification Cloud API

[commonly-ts]

Allows a notification to be sent to a user through a universe.

Example usage

// JavaScript

await noblox.setAPIKey(API_KEY!);

const universeId = 4434277335;
const targetUserId = 1210019099;
const assetId = "774d62e5-3414-b84a-89dd-77d96f1a3d33";

const parameters = {
    data: { stringValue: "Hello world!" }
};

await noblox.sendUserNotification(universeId, targetUserId, assetId, parameters);

Notification:

How it works

This pull request adds the sendUserNotification function that allows for example, a Discord bot to send a user a notification for a use case such as an application centre. A notification can be sent out to alert the user of their applications status.

Notifications are created through the Notifications tab under Engagement.

Custom text that is sent through the API is to be named and placed inside curly braces {myMessage}. To set the message, the code would look like this:

const parameters = {
    myMessage: { stringValue: "This is my message." }
};

This API requires the use of an API key. The given universeId must be added to the API key and given the scope user.user-notification:write.

Documentation

https://create.roblox.com/docs/production/promotion/experience-notifications#creating-a-notification-string
https://create.roblox.com/docs/cloud/reference/UserNotification

[Regalijan]

Also there's no typing added to the jsdocs

[Regalijan]

It needs a test case too but I'll probably do that myself

[Neztore]

What state is this PR in? @Regalijan

[Regalijan]

When I last checked it works, the problem is that I can't make a test for it until someone gets the account ready.

The api key also needs the user notification scope for that matter.

[Regalijan]

Looks fine to me now

[github-actions]

🎉 This PR is included in version 7.1.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀