Skip to content

Commit e42b955

Browse files
update Open Source Docs from Roblox internal teams
1 parent 39df6ab commit e42b955

25 files changed

+1239
-63
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -958,6 +958,16 @@ navigation:
958958
type: engineapi
959959
source: /reference/engine/classes/FeatureRestrictionManager.yaml
960960
ignoreTranslation: true
961+
- title: FeedPages
962+
path: /reference/engine/classes/FeedPages
963+
type: engineapi
964+
source: /reference/engine/classes/FeedPages.yaml
965+
ignoreTranslation: true
966+
- title: FeedService
967+
path: /reference/engine/classes/FeedService
968+
type: engineapi
969+
source: /reference/engine/classes/FeedService.yaml
970+
ignoreTranslation: true
961971
- title: File
962972
path: /reference/engine/classes/File
963973
type: engineapi
@@ -1788,6 +1798,11 @@ navigation:
17881798
type: engineapi
17891799
source: /reference/engine/classes/PitchShiftSoundEffect.yaml
17901800
ignoreTranslation: true
1801+
- title: PlaceAssetIdsService
1802+
path: /reference/engine/classes/PlaceAssetIdsService
1803+
type: engineapi
1804+
source: /reference/engine/classes/PlaceAssetIdsService.yaml
1805+
ignoreTranslation: true
17911806
- title: PlacesService
17921807
path: /reference/engine/classes/PlacesService
17931808
type: engineapi
@@ -4041,11 +4056,21 @@ navigation:
40414056
type: engineapi
40424057
source: /reference/engine/enums/FacialAnimationStreamingState.yaml
40434058
ignoreTranslation: true
4059+
- title: FacsActionUnit
4060+
path: /reference/engine/enums/FacsActionUnit
4061+
type: engineapi
4062+
source: /reference/engine/enums/FacsActionUnit.yaml
4063+
ignoreTranslation: true
40444064
- title: FACSDataLod
40454065
path: /reference/engine/enums/FACSDataLod
40464066
type: engineapi
40474067
source: /reference/engine/enums/FACSDataLod.yaml
40484068
ignoreTranslation: true
4069+
- title: FeedRankingScoreType
4070+
path: /reference/engine/enums/FeedRankingScoreType
4071+
type: engineapi
4072+
source: /reference/engine/enums/FeedRankingScoreType.yaml
4073+
ignoreTranslation: true
40494074
- title: FieldOfViewMode
40504075
path: /reference/engine/enums/FieldOfViewMode
40514076
type: engineapi

content/en-us/cloud/webhooks/webhook-notifications.md

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,26 @@ Once you set up a webhook, whenever a target event occurs, Roblox sends a reques
1717

1818
## Supported triggers
1919

20-
Roblox currently supports the following event triggers for notifications:
20+
Roblox currently supports the following event triggers.
2121

22-
### Subscriptions
22+
### Subscription
2323

24-
- **Subscription Cancelled** When a user cancels a [subscription](../../production/monetization/subscriptions.md), a message is sent containing the subscription and subscriber, as well as the reason given for the cancellation.
25-
- **Subscription Purchased** When a user purchases a subscription, a message is sent containing the subscription and subscriber.
26-
- **Subscription Refunded** When a user receives a refund for their subscription, a message is sent containing the subscription and subscriber.
27-
- **Subscription Renewed** When a user renews a subscription, a message is sent containing the subscription and subscriber.
28-
- **Subscription Resubscribed** When a user resubscribes to a subscription, a message is sent containing the subscription and subscriber.
24+
- **Subscription Resubscribed** - When a user resubscribes to a subscription, a message is sent containing the subscription and subscriber.
25+
- **Subscription Renewed** - When a user renews a subscription, a message is sent containing the subscription and subscriber.
26+
- **Subscription Refunded** - When a user receives a refund for their subscription, a message is sent containing the subscription and subscriber.
27+
- **Subscription Purchased** - When a user purchases a subscription, a message is sent containing the subscription and subscriber.
28+
- **Subscription Cancelled** - When a user cancels a [subscription](../../production/monetization/subscriptions.md), a message is sent containing the subscription and subscriber, as well as the reason given for the cancellation.
2929

30-
For more information on subscription events and their fields, see the [Cloud API Subscription](../../cloud/reference/Subscription/) reference.
30+
For more information on subscription events and their fields, see the [Subscription](/cloud/reference/Subscription/) reference.
3131

3232
### Compliance
3333

34-
- **Right to Erasure Request** When a user submits a data deletion request under the [General Data Protection Regulation (**GDPR**)](https://gdpr.eu/right-to-be-forgotten/).
34+
- **Right to Erasure Request** - When a user submits a data deletion request under the [General Data Protection Regulation](https://gdpr.eu/right-to-be-forgotten/) (GDPR).
3535

3636
### Commerce
3737

38-
- **Commerce Product Order Refunded** When a user has recieved a refund for their commerce product order.
39-
- **Commerce Product Order Paid** When a user has paid for their commerce product order.
38+
- **Commerce Product Order Refunded** - When a user has received a refund for their commerce product order.
39+
- **Commerce Product Order Paid** - When a user has paid for their commerce product order.
4040

4141
## Configure webhooks on Creator Dashboard
4242

@@ -51,10 +51,10 @@ To set up a webhook:
5151
1. Navigate to the [Webhooks](https://create.roblox.com/settings/webhooks) section of the Creator Dashboard.
5252
1. Click the **Add Webhook** button.
5353
1. Complete the configuration fields:
54-
1. **Webhook URL** Specify the URL where you can receive notifications. For more information on the requirements, see [Set up webhook URLs](#set-up-webhook-urls).
55-
2. **Name** Use a custom name to differentiate your configuration from others. By default the value is the same as the Webhook URL.
56-
3. **Secret** (optional) Supply a secret if you want to verify that notifications you receive are coming from Roblox. For more information, see [Verify webhook security](#verify-webhook-security).
57-
4. **Triggers** Choose one or more options from the list of [supported triggers](#supported-triggers) of events for which you want to receive notifications.
54+
1. **Webhook URL** - Specify the URL where you want to receive notifications. For more information on the requirements, see [Set up webhook URLs](#set-up-webhook-urls).
55+
2. **Name** - Use a custom name to differentiate your configuration from others. By default the value is the same as the Webhook URL.
56+
3. **Secret** (optional) - Supply a secret if you want to verify that notifications you receive are coming from Roblox. For more information, see [Verify webhook security](#verify-webhook-security).
57+
4. **Triggers** - Choose one or more options from the list of [supported triggers](#supported-triggers) of events for which you want to receive notifications.
5858
1. Click the **Save Changes** button.
5959

6060
<Alert severity="info">
@@ -98,9 +98,9 @@ You can test whether the webhook you've configured can successfully receive noti
9898
3. Click the pencil icon next to the target webhook.
9999
4. Click the **Test Response** button.
100100

101-
A `SampleNotification` event is sent, which includes the **User ID** of the user who triggers the notification, as the following example schema shows:
101+
The system then sends a `SampleNotification` event, which includes the **User ID** of the user who triggered the notification, as shown here:
102102

103-
```json title="SampleNotification Schema"
103+
```json title="SampleNotification schema"
104104
{
105105
"NotificationId": "string",
106106
"EventType": "SampleNotification",
@@ -115,20 +115,16 @@ If you are integrating your webhook with a third-party service, you can test it
115115

116116
## Verify webhook security
117117

118-
Once you configure your server to receive payloads, it starts to listen for any payload sent to the endpoint. If you set a secret when configuring your webhook, Roblox sends a `roblox-signature` in each webhook notification to ensure that the request actually came from Roblox. The signature is in the payload header for custom endpoints and in the footer for third-party servers.
119-
120-
```csv title="Signature Format with a Secret for Custom Endpoints"
118+
After you configure your server to receive payloads, it starts to listen for any payload sent to the endpoint. If you set a secret when configuring your webhook, Roblox sends a `roblox-signature` in each webhook notification to ensure that the request actually came from Roblox. The signature is in the payload header for custom endpoints and in the footer for third-party servers.
121119

120+
```csv title="Signature format with a secret for custom endpoints"
122121
t=<timestamp>,v1=<signature>
123-
124122
```
125123

126-
If you did not set a secret for your webhook, the signature will only contain the timestamp of when the notification was sent:
127-
128-
```csv title="Signature Format without a Secret for Custom Endpoints"
124+
If you did not set a secret for your webhook, the signature only contains the timestamp of when the notification was sent:
129125

126+
```csv title="Signature format without a secret for custom endpoints"
130127
t=<timestamp>
131-
132128
```
133129

134130
To verify a signature:
@@ -138,7 +134,7 @@ To verify a signature:
138134

139135
1. Extract the timestamp and signature values. All signatures for webhooks with secrets share the same format as a CSV string with these two values following by the prefixes:
140136

141-
- `t`: The timestamp of when the notification is sent.
137+
- `t`: The timestamp of when the notification was sent.
142138
- `v1`: The signature value generated using the secret provided by the Creator Dashboard configuration.
143139

144140
1. Re-create the base string of `roblox-signature` by concatenating:
@@ -195,9 +191,9 @@ The **variable payload schema fields** provides flexibility for webhooks to acco
195191

196192
1. `EventPayload` (object): Contains information specific to the `EventType` that triggered the webhook. The structure of the `EventPayload` schema varies based on the type of event.
197193

198-
The following example shows the payload schema of the **Right To Erasure Request** event:
194+
The following example shows the payload schema of the **Right To Erasure request** event:
199195

200-
```json title="Example Schema for Right to Erasure Request"
196+
```json title="Example schema for a Right to Erasure request"
201197
{
202198
"NotificationId": "string",
203199
"EventType": "RightToErasureRequest",
@@ -221,7 +217,7 @@ If you use a custom endpoint as your webhook server instead of a third-party too
221217
const crypto = require('crypto');
222218
const express = require('express');
223219

224-
const secret = '<Your secret>' // This can be set as an environment variable
220+
const secret = '<your_secret>' // This can be set as an environment variable
225221

226222
let app = express();
227223
app.use(express.json());

content/en-us/reference/engine/classes/CanvasGroup.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,18 @@ properties:
7272
description: ''
7373
code_samples: []
7474
type: float
75-
tags: []
75+
tags:
76+
- Hidden
77+
- NotReplicated
7678
deprecation_message: ''
7779
security:
7880
read: RobloxScriptSecurity
7981
write: RobloxScriptSecurity
8082
thread_safety: ReadSafe
8183
category: Data
8284
serialization:
83-
can_load: true
84-
can_save: true
85+
can_load: false
86+
can_save: false
8587
capabilities:
8688
- UI
8789
writeCapabilities: []

content/en-us/reference/engine/classes/CaptureService.yaml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,48 @@ methods:
134134
thread_safety: Unsafe
135135
capabilities: []
136136
writeCapabilities: []
137+
- name: CaptureService:StartVideoCaptureInternal
138+
summary: ''
139+
description: ''
140+
code_samples: []
141+
parameters: []
142+
returns:
143+
- type: ()
144+
summary: ''
145+
tags: []
146+
deprecation_message: ''
147+
security: RobloxScriptSecurity
148+
thread_safety: Unsafe
149+
capabilities: []
150+
writeCapabilities: []
151+
- name: CaptureService:StopCapture
152+
summary: ''
153+
description: ''
154+
code_samples: []
155+
parameters: []
156+
returns:
157+
- type: ()
158+
summary: ''
159+
tags: []
160+
deprecation_message: ''
161+
security: RobloxScriptSecurity
162+
thread_safety: Unsafe
163+
capabilities: []
164+
writeCapabilities: []
165+
- name: CaptureService:StopVideoCaptureInternal
166+
summary: ''
167+
description: ''
168+
code_samples: []
169+
parameters: []
170+
returns:
171+
- type: ()
172+
summary: ''
173+
tags: []
174+
deprecation_message: ''
175+
security: RobloxScriptSecurity
176+
thread_safety: Unsafe
177+
capabilities: []
178+
writeCapabilities: []
137179
- name: CaptureService:TakeCapture
138180
summary: ''
139181
description: ''

content/en-us/reference/engine/classes/ConfigService.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,46 @@ tags:
1414
deprecation_message: ''
1515
properties: []
1616
methods:
17+
- name: ConfigService:ClearTestingValue
18+
summary: ''
19+
description: ''
20+
code_samples: []
21+
parameters:
22+
- name: key
23+
type: string
24+
default:
25+
summary: ''
26+
returns:
27+
- type: ()
28+
summary: ''
29+
tags: []
30+
deprecation_message: ''
31+
security: None
32+
thread_safety: Unsafe
33+
capabilities: []
34+
writeCapabilities: []
35+
- name: ConfigService:SetTestingValue
36+
summary: ''
37+
description: ''
38+
code_samples: []
39+
parameters:
40+
- name: key
41+
type: string
42+
default:
43+
summary: ''
44+
- name: value
45+
type: Variant
46+
default:
47+
summary: ''
48+
returns:
49+
- type: ()
50+
summary: ''
51+
tags: []
52+
deprecation_message: ''
53+
security: None
54+
thread_safety: Unsafe
55+
capabilities: []
56+
writeCapabilities: []
1757
- name: ConfigService:GetConfigAsync
1858
summary: ''
1959
description: ''

0 commit comments

Comments
 (0)