Skip to content

Commit 666f65a

Browse files
update Open Source Docs from Roblox internal teams
1 parent 7ef5e99 commit 666f65a

29 files changed

+353
-425
lines changed

content/common/navigation/engine/guides.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ navigation:
208208
section:
209209
- title: Overview
210210
path: /scripting/events/
211-
- title: Deferred Events
211+
- title: Deferred
212212
path: /scripting/events/deferred
213213
- title: Bindable
214214
path: /scripting/events/bindable
@@ -576,16 +576,16 @@ navigation:
576576
path: /production/promotion/sponsoring-items
577577
- title: Complying with Advertising Standards
578578
path: /production/promotion/complying-with-advertising-standards
579-
- title: Audience Engagement
580-
path: /production/promotion/audience-engagement
581-
- title: Experience Events
579+
- title: Events and Updates
582580
path: /production/promotion/experience-events
581+
- title: Experience Notifications
582+
path: /production/promotion/experience-notifications
583+
- title: Social Media Links
584+
path: /production/promotion/social-media-links
583585
- title: Player Invite Prompts
584586
path: /production/promotion/invite-prompts
585587
- title: Friend Invite Reward System
586588
path: /production/promotion/referral-system
587-
- title: Experience Notifications
588-
path: /production/promotion/experience-notifications
589589
- title: Nominating for the Discover Page
590590
path: /production/promotion/nominating-for-the-discover-page
591591
- title: Getting Featured on Roblox‑Owned Channels
Lines changed: 2 additions & 2 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/assets/creator-dashboard/Experience-Nav-Engagement-Events.png

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 2 additions & 2 deletions
Loading
Lines changed: 2 additions & 2 deletions
Loading
Lines changed: 2 additions & 2 deletions
Loading

content/en-us/assets/creator-dashboard/Experience-Nav-Engagement-Updates.png

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Loading

content/en-us/cloud/open-cloud/experience-notifications.md

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ description: Experience Notifications are a way for users to keep up with their
55

66
import Intro from '../../includes/experience-notifications/intro.md'
77
import Eligibility from '../../includes/experience-notifications/eligibility.md'
8-
import UserExperienceEnabling from '../../includes/experience-notifications/user-experience-enabling.md'
9-
import UserExperienceReceiving from '../../includes/experience-notifications/user-experience-receiving.md'
10-
import UserExperienceExamples from '../../includes/experience-notifications/user-experience-examples.md'
11-
import UserExperienceBestPractices from '../../includes/experience-notifications/user-experience-best-practices.md'
128
import ImplementationCreateNotificationString from '../../includes/experience-notifications/implementation-create-notification-string.md'
139
import DeliverySystem from '../../includes/experience-notifications/delivery-system.md'
1410
import AnalyticsOverview from '../../includes/experience-notifications/analytics-overview.md'
@@ -18,35 +14,19 @@ import Guidelines from '../../includes/experience-notifications/guidelines.md'
1814

1915
<Intro components={props.components} />
2016

21-
## Experience Eligibility Requirements
17+
## Eligibility Requirements
2218

2319
<Eligibility components={props.components} />
2420

25-
## User Experience
21+
## Usage Guidelines
2622

27-
### Enabling Notifications
28-
29-
Users of age 13+ are eligible to receive Experience Notifications and can enable them by clicking the **Notify** button on your experience's details screen, or through an [in‑experience permission prompt](../../cloud-services/experience-notifications.md#prompting-users-to-enable-notifications) within your experience.
30-
31-
<UserExperienceEnabling components={props.components} />
32-
33-
### Receiving Notifications
34-
35-
<UserExperienceReceiving components={props.components} />
36-
37-
### Example Notifications
38-
39-
<UserExperienceExamples components={props.components} />
40-
41-
### Best Practices
42-
43-
<UserExperienceBestPractices components={props.components} />
23+
<Guidelines components={props.components} />
4424

4525
## Implementation
4626

4727
Implementing Experience Notifications begins with [creating a notification string](#creating-a-notification-string). Once a notification string is set up, you can [send notifications](#sending-an-experience-notification) with optional [custom parameters](#customizing-notifications-using-parameters).
4828

49-
Alternatively, you can use the [Engine API](../../cloud-services/experience-notifications.md) to trigger notifications through server-side scripts.
29+
Alternatively, you can use the [Engine API](../../production/promotion/experience-notifications.md) to trigger notifications through server-side scripts.
5030

5131
### Creating a Notification String
5232

@@ -56,10 +36,14 @@ Alternatively, you can use the [Engine API](../../cloud-services/experience-noti
5636

5737
The [UserNotification](../../cloud/reference/UserNotification) API lets you send Experience Notifications to users. Before using it, you must [generate an API key](../../cloud/open-cloud/api-keys.md) or [configure OAuth 2.0](../../cloud/open-cloud/oauth2-overview.md) for your app. The examples on this page use API keys.
5838

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](#including-launch-and-analytics-data).
40+
41+
<img src="../../assets/open-cloud/experience-notifications/Notification-Stream.png" width="393" alt="Notifications stream on the Roblox app" />
42+
5943
To send an Experience Notification to a user:
6044

6145
1. Copy the API key to the `x-api-key` request header of the [Create User Notification](../../cloud/reference/UserNotification#Create-User-Notification) call.
62-
1. In your request:
46+
2. In your request:
6347

6448
1. Copy the notification string asset ID as the value of the `payload.message_id` property.
6549
2. Set `payload.type` to `"MOMENT"`.
@@ -93,7 +77,7 @@ Example response which returns the notification ID in the `id` field:
9377

9478
To customize the notification for each recipient, you can include **parameters** in the [notification string](#creating-a-notification-string), then customize the parameters when calling the API. For example, you can define the notification string as:
9579

96-
- <Typography variant="subtitle2" color="primary">\{userId-friend\} beat your high score by \{points\} points! Time to level up?</Typography>
80+
<p><Chip label="{userId-friend} beat your high score by {points} points! Time to level up?" size="large" color="primary" variant="outlined" /></p>
9781

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

@@ -156,7 +140,3 @@ curl --location 'https://apis.roblox.com/cloud/v2/users/${UserId}/notifications'
156140
### Itemized Stats
157141

158142
<AnalyticsItemizedStats components={props.components} />
159-
160-
## Guidelines
161-
162-
<Guidelines components={props.components} />

0 commit comments

Comments
 (0)