You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Send experience notifications from the web with Open Cloud APIs. Experience notifications are a way for users to keep up with their favorite experiences through timely, personalized notifications.
2
+
title: User notifications
3
+
description: Use Open Cloud to send experience notifications to users. Help players keep up with their favorite experiences through timely, personalized notifications.
4
4
---
5
5
6
6
import Intro from '../../includes/experience-notifications/intro.md'
7
-
import Eligibility from '../../includes/experience-notifications/eligibility.md'
8
-
import ImplementationCreateNotificationString from '../../includes/experience-notifications/implementation-create-notification-string.md'
9
-
import DeliverySystem from '../../includes/experience-notifications/delivery-system.md'
10
-
import AnalyticsOverview from '../../includes/experience-notifications/analytics-overview.md'
11
-
import AnalyticsNotificationsSummary from '../../includes/experience-notifications/analytics-notification-summary.md'
12
-
import AnalyticsItemizedStats from '../../includes/experience-notifications/analytics-itemized-stats.md'
13
-
import Guidelines from '../../includes/experience-notifications/guidelines.md'
14
7
15
8
<Introcomponents={props.components} />
16
9
17
-
## Eligibility requirements
10
+
After they receive a notification, users can join the experience directly via the **Join** button and spawn according to your [launch data](#include-launch-and-analytics-data).
18
11
19
-
<Eligibilitycomponents={props.components} />
20
-
21
-
## Usage guidelines
22
-
23
-
<Guidelinescomponents={props.components} />
12
+
For more information on features, eligibility requirements, usage guidelines, and the corresponding Engine API, see the [Experiences guide](../../production/promotion/experience-notifications.md).
24
13
25
14
## Implementation
26
15
27
-
Implementing Experience Notifications begins with [creating a notification string](#create-a-notification-string). Once a notification string is set up, you can [send notifications](#send-an-experience-notification) with optional [custom parameters](#customize-notifications-using-parameters).
28
-
29
-
Alternatively, you can use the [Engine API](../../production/promotion/experience-notifications.md) to trigger notifications through server-side scripts.
The [UserNotification](../../cloud/reference/UserNotification) API lets you send Experience Notifications to users. Before using it, you must [generate an API key](../../cloud/auth/api-keys.md) or [configure OAuth 2.0](../../cloud/auth/oauth2-overview.md) for your app. The examples on this page use API keys.
38
-
39
-
Notifications will be delivered to [opted-in](https://en.help.roblox.com/hc/en-us/articles/24769602332692-Out-of-Experience-Notifications) 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](#include-launch-and-analytics-data).
16
+
The [UserNotification](/cloud/reference/UserNotification) resource lets you send experience notifications to users. Before using it, you must [generate an API key](../../cloud/auth/api-keys.md) or [configure OAuth 2.0](../../cloud/auth/oauth2-overview.md) for your app. The examples on this page use API keys.
40
17
41
-
<imgsrc="../../assets/open-cloud/experience-notifications/Notification-Stream.png"width="393"alt="Notifications stream on the Roblox app" />
42
-
43
-
To send an Experience Notification to a user:
44
-
45
-
1. Copy the API key to the `x-api-key` request header of the [Create User Notification](../../cloud/reference/UserNotification#Create-User-Notification) call.
46
-
2. In your request:
18
+
To send an experience notification to a user:
47
19
20
+
1.[Create a notification string](../../production/promotion/experience-notifications.md#create-a-notification-string) in the [Creator Dashboard](https://create.roblox.com/dashboard/creations). This step must be done in the Creator Dashboard; there's no Open Cloud API for it.
21
+
1. Form the request:
22
+
1. Copy the API key to the `x-api-key` request header.
48
23
1. Copy the notification string asset ID as the value of the `payload.message_id` property.
49
-
2. Set `payload.type` to `"MOMENT"`.
50
-
3. Set `source.universe` to be the universe resource URL `"universes/${UniverseID}"`.
24
+
1. Set `payload.type` to `"MOMENT"`.
25
+
1. Set `source.universe` to be the universe resource URL `"universes/${UniverseID}"`.
@@ -75,11 +50,11 @@ Example response which returns the notification ID in the `id` field:
75
50
76
51
### Customize notifications using parameters
77
52
78
-
To customize the notification for each recipient, you can include **parameters** in the [notification string](#create-a-notification-string), then customize the parameters when calling the API. For example, you can define the notification string as:
53
+
To customize the notification for each recipient, include **parameters** in the [notification string](#implementation). Then customize the parameters when calling the API. For example, you can define the notification string as:
79
54
80
55
<p><Chiplabel="{userId-friend} beat your high score by {points} points! Time to level up?"size="large"color="primary"variant="outlined" /></p>
81
56
82
-
Then, set the `userId-friend` and `points` parameters in the script:
57
+
Add the `userId-friend` and `points` parameters in the script:
83
58
84
59
```bash title="Customize Notification Using Parameters"
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](#analytics) data to segment the performance of different categories of notifications.
80
+
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](../../production/promotion/experience-notifications.md#analytics) data to segment the performance of different categories of notifications.
106
81
107
82
```bash title="Include Launch Data and Analytics Data"
Each user can receive **one** notification per day from a given experience, and you receive transparent feedback when a user's throttle limit is reached.
There are many other reasons that a notification might not be delivered. For more information, see [Delivery system](../../production/promotion/experience-notifications.md#delivery-system) in the Engine guide.
Copy file name to clipboardExpand all lines: content/en-us/creator-fund.md
+2-16Lines changed: 2 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,8 @@ With the launch of the Creator Fund, we want new and existing developers to have
9
9
10
10
<figure>
11
11
<Chip
12
-
color="success"
13
-
label="Status: Open"
12
+
color="error"
13
+
label="Status: Closed"
14
14
size="medium"
15
15
variant="filled"/>
16
16
</figure>
@@ -28,17 +28,3 @@ We prioritize projects that encompass:
28
28
- In-experience avatars that reflect elements of the user's platform avatar identity. Ability to leverage items that you can equip on platform avatars, like the ones you buy in the [Marketplace](https://www.roblox.com/catalog).
29
29
30
30
If you are accepted into the program, we partner with you to define key deliverables for your project and provide funding based off of your progress towards these milestones.
31
-
32
-
## Application requirements
33
-
34
-
- 18+ age requirement.
35
-
- Details about you and/or your team.
36
-
- Short description of your project.
37
-
- Pitch deck of high-level strategy, design specifications, etc.
38
-
- Project milestone schedule and budget.
39
-
40
-
If you feel like you and your project are a perfect fit for this program, please submit your application.
description: RDC is an invite-only, hybrid (in-person and online) event that brings together Roblox developers, brands, and creators worldwide.
4
4
---
5
5
6
-
RDC is an invite-only, hybrid (in-person and online) event that brings together Roblox developers, brands, and creators worldwide. There will be networking opportunities, in-depth breakout sessions, product demonstrations, and office hours—all designed to empower your success and showcase the future of Roblox.
6
+
Roblox Developers Conference (RDC) is coming back as a virtual and in-person event to San Jose on September 5-6! RDC is an invite-only event that brings together Roblox developers, brands, and creators worldwide. There will be networking opportunities, in-depth breakout sessions, product demonstrations, and office hours—all designed to empower your success and showcase the future of Roblox.
Copy file name to clipboardExpand all lines: content/en-us/discovery.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -183,6 +183,6 @@ Roblox is [committed](https://devforum.roblox.com/t/discovery-on-roblox-past-pre
183
183
184
184
### Notifications
185
185
186
-
**Notifications** elevate timely and actionable information to users. Historically, we have focused on building and scaling social notifications, such as friend requests and invitations. This system allows for creators to engage with users directly while they are away. Milestones, high scores, [friend activity](https://devforum.roblox.com/t/user-mentions-in-experience-notifications/2980675), and other key moments can be delivered to users as personalized notifications to the notification stream. For additional information and implementation instructions, see [Experience Notifications](./cloud/guides/experience-notifications.md).
186
+
**Notifications** elevate timely and actionable information to users. Historically, we have focused on building and scaling social notifications, such as friend requests and invitations. This system allows for creators to engage with users directly while they are away. Milestones, high scores, [friend activity](https://devforum.roblox.com/t/user-mentions-in-experience-notifications/2980675), and other key moments can be delivered to users as personalized notifications to the notification stream. For additional information and implementation instructions, see [Experience notifications](./cloud/guides/experience-notifications.md).
187
187
188
188
You can also use our [in-experience notification permission prompts](https://devforum.roblox.com/t/introducing-in-experience-notification-permission-prompts/2909125) to upsell notification opt-in within experiences. Notifications can help resurrect lapsed users or remind users when they need to take an action.
Copy file name to clipboardExpand all lines: content/en-us/includes/experience-notifications/delivery-system.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: include
4
4
5
5
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](#analytics) dashboard, as explained below.
6
6
7
-
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.
7
+
Experience notifications have a static throttle limit; each user can receive one notification per day from a given experience, and you receive transparent feedback when a user's throttle limit is reached.
8
8
9
9
Additionally, the following list outlines some of the special cases which may result in **non‑delivery** of a notification:
0 commit comments