Experience Notifications

Experience Notifications are a way for opted-in users age 13+ to keep up with their favorite experiences through timely, personalized notifications. As the developer, you can determine what kinds of in‑experience activities are most important to notify your users about, as well as define the notification content.

The Experience Notification system features the following:

• Customizable Notifications with Parameters — Full flexibility to customize the notification message with parameters, for example:

  Your gold goose egg has hatched!

  Allie @LaterSk8er1 just beat your record on the Tokyo Tour track!

• Launch Data — Include optional launch data that can be read through Player:GetJoinData() when the notification recipient joins. This could involve routing a user to a coordinate location or personalizing their joining experience.

• Analytics Support — Track your reachable audience and the performance of your notifications in the Creator Dashboard.

Eligibility Requirements

In order to use the APIs to send notifications, the experience must meet the following base criteria:

• Minimum 100 visits since launch.
• The experience must not be under moderation.
• You as the developer must have permission to manage the experience.

Usage Guidelines

Implementation

Implementing Experience Notifications begins with creating a notification string and including the package in your project. Once these are set up, you can send notifications with optional custom parameters.

Alternatively, you can use the Open Cloud API to trigger notifications through freeform API requests.

Creating a Notification String

As with Player Invite Prompts, you must create and edit your notification strings in the Creator Dashboard. There is no default Experience Notification string, so this step is required.

1. Navigate to the Creator Dashboard.

2. Similar to badges, notification strings are tied to a specific experience. Locate that experience's thumbnail and click on it.

3. In the left column, under Engagement, click Notifications.

   

4. In the center region, click the Create a Notification String button.

5. Fill in an identifier name (only visible to you) and the custom notification string; this is limited to 99 characters and can include unlimited custom parameters. Notifications will automatically use the title of your experience as the notification title, but you can additionally use {experienceName} to reference your experience in the notification body text.

   Example notification strings:

   You're {numQuests} quests away from completing the weekly challenge!

   Your {eggName} hatched! Come meet your new pet.

   You won {numRaces} races this week and unlocked the {racetrackName} track!

   {userId-friend} just beat your record on the Tokyo Tour track! Time for revenge?

   Before writing notification strings, please review the guidelines for using the system.

6. When ready, click the Create Notification String button.

7. On the notifications page, click the ⋯ button for the notification and select Copy Asset ID.

   

8. Use the copied ID for the messageId key value in the payload table as demonstrated in the example script.

Including the Package

To implement Experience Notifications, you must obtain the Lua package from the Creator Store.

1. From the View tab, open the Toolbox and select the Creator Store tab.

   

2. Make sure the Models sorting is selected, then click the See All button for Categories.

   

3. Locate and click the Dev Modules tile.

   

4. Locate the Open Cloud module and click it, or drag‑and‑drop it into the 3D view.

   

5. In the Explorer window, move the entire OpenCloud model into ServerScriptService.

   

Sending an Experience Notification

Once you've created a notification string and included the package in your project, you can send notifications from server‑side scripts. Notifications will be delivered to opted-in users age 13+ through their Roblox notification stream, at which point they can join the experience directly via the Join button on the notification and spawn according to your launch data.

To send a basic notification to a specific user, include the notification string asset ID in the payload's messageId field, then call the createUserNotification function with the recipient's Player.UserId and the request data.

Send an Experience Notification
local ServerScriptService = game:GetService("ServerScriptService")

local OCUserNotification = require(ServerScriptService.OpenCloud.V2.UserNotification)
local recipientPlayerID = 505306092

-- In the payload, "messageId" is the value of the notification asset ID
local userNotification = {
	payload = {
		messageId = "5dd7024b-68e3-ac4d-8232-4217f86ca244",
		type = "MOMENT"
	}
}

local result = OCUserNotification.createUserNotification(recipientPlayerID, userNotification)

if result.statusCode ~= 200 then
	print(result.statusCode)
	print(result.error.code)
	print(result.error.message)
end

Customizing Notifications Using Parameters

To customize the notification for each recipient, you can include parameters in the notification string, then customize the parameters when calling the API. For example, you can define the notification string as:

Then, set the userId-friend and points parameters in the script:

Customize Notification Using Parameters
local ServerScriptService = game:GetService("ServerScriptService")

local OCUserNotification = require(ServerScriptService.OpenCloud.V2.UserNotification)
local recipientPlayerID = 505306092

local userIdFriendParam = {int64Value = 3702832553}
local pointsParam = {stringValue = "5"}

-- In the payload, "messageId" is the value of the notification asset ID
-- In this example, the notification string is "{userId-friend} beat your high score by {points} points! Time to level up?"
local userNotification = {
	payload = {
		messageId = "ef0e0790-e2e8-4441-9a32-93f3a5783bf1",
		type = "MOMENT",
		parameters = {
			["userId-friend"] = userIdFriendParam,
			["points"] = pointsParam
		}
	}
}

local result = OCUserNotification.createUserNotification(recipientPlayerID, userNotification)

if result.statusCode ~= 200 then
	print(result.statusCode)
	print(result.error.code)
	print(result.error.message)
end

Prompting Users to Enable Notifications

To encourage users to enable notifications for your experience, you can display an in‑experience permission prompt to users age 13+ using the ExperienceNotificationService:PromptOptIn() method.

You can trigger the prompt in any suitable context within your experience that warrants a future notification. The prompt's text is not customizable and is standardized across all experiences.

The modal will not appear if the user:

• Is under the age of 13.
• Has already enabled notifications for your experience.
• Has already seen the permission prompt for your experience in the past 30 days.

To prompt users to enable notifications, you should first determine whether the user is eligible. Once confirmed, you can display the permission prompt to the user.

1. Call ExperienceNotificationService:CanPromptOptInAsync(), wrapped in a pcall() since it's an asynchronous network call that may occasionally fail.
2. If the user can be prompted, call ExperienceNotificationService:PromptOptIn().

LocalScript - Notification Permission Prompt Implementation
local ExperienceNotificationService = game:GetService("ExperienceNotificationService")

-- Function to check whether the player can be prompted to enable notifications
local function canPromptOptIn()
	local success, canPrompt = pcall(function()
		return ExperienceNotificationService:CanPromptOptInAsync()
	end)
	return success and canPrompt
end

local canPrompt = canPromptOptIn()
if canPrompt then
	local success, errorMessage = pcall(function()
		ExperienceNotificationService:PromptOptIn()
	end)
end

-- Listen to opt-in prompt closed event
ExperienceNotificationService.OptInPromptClosed:Connect(function()
	print("Opt-in prompt closed")
end)

Including Launch and Analytics Data

To further improve user experience, you can include launch data in the notification, useful for scenarios such as routing users to a coordinate location or personalizing the joining experience. Additionally, you can include analytics data to segment the performance of different categories of notifications. Please also refer to the Player Invite Prompts example on how launch data can be set and used.

Include Launch Data and Analytics Data
local ServerScriptService = game:GetService("ServerScriptService")

local OCUserNotification = require(ServerScriptService.OpenCloud.V2.UserNotification)
local recipientPlayerID = 505306092

-- In the payload, "messageId" is the value of the notification asset ID
local userNotification = {
	payload = {
		messageId = "5dd7024b-68e3-ac4d-8232-4217f86ca244",
		type = "MOMENT",
		joinExperience = {
			launchData = "Test_Launch_Data"
		},
		analyticsData = {
			category = "Test_Analytics_Category"
		}
	}
}

local result = OCUserNotification.createUserNotification(recipientPlayerID, userNotification)

if result.statusCode ~= 200 then
	print(result.statusCode)
	print(result.error.code)
	print(result.error.message)
end

Delivery System

A spam prevention system exists to ensure the quality of notifications for users and protect the shared notification channel for all developers. Because of this, delivery of notifications is not guaranteed. This spam prevention system is directly informed by user engagement: the more users engage with your notifications, the more reach they'll receive. You can transparently track engagement metrics in the analytics dashboard, as explained below.

Experience Notifications have a static throttle limit where each user can receive one notification per day from a given experience and you'll receive transparent feedback when a user's throttle limit is reached.

Additionally, the following list outlines some of the special cases which may result in non‑delivery of a notification:

• Experience eligibility requirements are not met.
• Recipient is not opted in to notifications from your experience.
• Recipient's throttle limit for your experience has been reached.
• Recipient's aggregate daily throttle limit has been reached.
• Missing or invalid request parameters.
• Notification string was moderated.
• For notifications with user mentions, non-delivery occurs if either of these conditions are met:

  • The receiver and mentioned user are not friends.
  • The mentioned user has No selected for "Update friends about my activity?" under Privacy → Other Settings in their Roblox account settings.

Analytics

Performance of your notifications and notifiable audience are displayed in the Analytics tab of the Notifications page where you configure notification strings (simply tab from Creations to Analytics).

1. Navigate to the Creator Dashboard.

2. Similar to badges, notification strings are tied to a specific experience. Locate that experience's thumbnail and click on it.

3. In the left column, under Engagement, click Notifications.

   

4. On the target page, click the Analytics tab to switch to the analytics dashboard.

   

Notifications Summary

The summary section serves as a snapshot of the aggregate performance of your notifications. A minimum of 100 aggregate impressions is required to display the performance statistics.

Itemized Stats

The Experience Notifications table displays detailed performance statistics for each notification with at least 100 impressions, ordered by the date of first impression for that notification.

The Name column is the key identifier for the notification. By default, the name matches the identifier name you specified when creating the notification string, but you can override it through the category field in your API calls, in which case category overrides the name. Changing the string name in the Creator Dashboard or changing the string your message ID references in the API call will generate a new row in the table.

If you'd like to A/B test the performance of different strings, it's recommended that you create an entirely new notification string with a similar name, for example:

• EggHatchA — "Your gold egg has hatched! Come meet your new pet."
• EggHatchB — "It's hatching time! Come meet your new pet."

API Reference

Functions

createUserNotification

Sends a notification from a server‑side script. Requires the recipient's Player.UserId and a UserNotification. Returns a UserNotificationResult.

Send an Experience Notification
local ServerScriptService = game:GetService("ServerScriptService")

local OCUserNotification = require(ServerScriptService.OpenCloud.V2.UserNotification)
local recipientPlayerID = 505306092

-- In the payload, "messageId" is the value of the notification asset ID
local userNotification = {
	payload = {
		messageId = "5dd7024b-68e3-ac4d-8232-4217f86ca244",
		type = "MOMENT"
	}
}

local result = OCUserNotification.createUserNotification(recipientPlayerID, userNotification)

if result.statusCode ~= 200 then
	print(result.statusCode)
	print(result.error.code)
	print(result.error.message)
end

Types

UserNotification

Table containing details on the notification to be sent to the user. Must contain a payload table with required messageId and type strings, and optional parameters, joinExperience, and analyticsData tables.

UserNotificationResult

A wrapper object that holds the response from a sent notification. Contains the following key‑value pairs: