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
Copy file name to clipboardExpand all lines: content/en-us/cloud/open-cloud/experience-notifications.md
+10-30Lines changed: 10 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,6 @@ description: Experience Notifications are a way for users to keep up with their
5
5
6
6
import Intro from '../../includes/experience-notifications/intro.md'
7
7
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'
12
8
import ImplementationCreateNotificationString from '../../includes/experience-notifications/implementation-create-notification-string.md'
13
9
import DeliverySystem from '../../includes/experience-notifications/delivery-system.md'
14
10
import AnalyticsOverview from '../../includes/experience-notifications/analytics-overview.md'
@@ -18,35 +14,19 @@ import Guidelines from '../../includes/experience-notifications/guidelines.md'
18
14
19
15
<Introcomponents={props.components} />
20
16
21
-
## Experience Eligibility Requirements
17
+
## Eligibility Requirements
22
18
23
19
<Eligibilitycomponents={props.components} />
24
20
25
-
## User Experience
21
+
## Usage Guidelines
26
22
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.
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).
48
28
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.
50
30
51
31
### Creating a Notification String
52
32
@@ -56,10 +36,14 @@ Alternatively, you can use the [Engine API](../../cloud-services/experience-noti
56
36
57
37
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.
58
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](#including-launch-and-analytics-data).
40
+
41
+
<imgsrc="../../assets/open-cloud/experience-notifications/Notification-Stream.png"width="393"alt="Notifications stream on the Roblox app" />
42
+
59
43
To send an Experience Notification to a user:
60
44
61
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.
62
-
1. In your request:
46
+
2. In your request:
63
47
64
48
1. Copy the notification string asset ID as the value of the `payload.message_id` property.
65
49
2. Set `payload.type` to `"MOMENT"`.
@@ -93,7 +77,7 @@ Example response which returns the notification ID in the `id` field:
93
77
94
78
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:
95
79
96
-
- <Typographyvariant="subtitle2"color="primary">\{userId-friend\} beat your high score by \{points\} points! Time to level up?</Typography>
80
+
<p><Chiplabel="{userId-friend} beat your high score by {points} points! Time to level up?"size="large"color="primary"variant="outlined" /></p>
97
81
98
82
Then, set the `userId-friend` and `points` parameters in the script:
0 commit comments