Skip to content

Commit a544734

Browse files
authored
Document entitlement update & delete webhook events (#7919)
1 parent 4fe8e0b commit a544734

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

docs/events/webhook-events.mdx

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,8 @@ The "Value" column corresponds to the event's `type` field value in the [event b
137137
| [Application Authorized](/docs/events/webhook-events#application-authorized) | `APPLICATION_AUTHORIZED` | Sent when an app was authorized by a user to a server or their account |
138138
| [Application Deauthorized](/docs/events/webhook-events#application-deauthorized) | `APPLICATION_DEAUTHORIZED` | Sent when an app was deauthorized by a user |
139139
| [Entitlement Create](/docs/events/webhook-events#entitlement-create) | `ENTITLEMENT_CREATE` | Entitlement was created |
140+
| [Entitlement Update](/docs/events/webhook-events#entitlement-update) | `ENTITLEMENT_UPDATE` | Entitlement was updated |
141+
| [Entitlement Delete](/docs/events/webhook-events#entitlement-delete) | `ENTITLEMENT_DELETE` | Entitlement was deleted |
140142
| [Quest User Enrollment](/docs/events/webhook-events#quest-user-enrollment) | `QUEST_USER_ENROLLMENT` | User was added to a Quest (currently unavailable) |
141143
| [Lobby Message Create](/docs/events/webhook-events#lobby-message-create) | `LOBBY_MESSAGE_CREATE` | Sent when a message is created in a lobby |
142144
| [Lobby Message Update](/docs/events/webhook-events#lobby-message-update) | `LOBBY_MESSAGE_UPDATE` | Sent when a message is updated in a lobby |
@@ -244,6 +246,72 @@ The inner payload is an [entitlement](/docs/resources/entitlement#entitlement-ob
244246
}
245247
```
246248

249+
#### Entitlement Update
250+
251+
`ENTITLEMENT_UPDATE` is sent when an [entitlement](/docs/resources/entitlement) is updated. Refer to the [Monetization documentation](/docs/monetization/overview) for details.
252+
253+
###### Entitlement Update Structure
254+
255+
The inner payload is an [entitlement](/docs/resources/entitlement#entitlement-object) object.
256+
257+
###### Entitlement Update Example
258+
259+
```json
260+
{
261+
"version": 1,
262+
"application_id": "1234560123453231555",
263+
"type": 1,
264+
"event": {
265+
"type": "ENTITLEMENT_UPDATE",
266+
"timestamp": "2024-10-18T18:41:21.109604",
267+
"data": {
268+
"application_id": "1234560123453231555",
269+
"consumed": false,
270+
"deleted": false,
271+
"gift_code_flags": 0,
272+
"id": "1234505980407808808",
273+
"promotion_id": null,
274+
"sku_id": "123489045643835123",
275+
"type": 4,
276+
"user_id": "111178765189277770"
277+
}
278+
}
279+
}
280+
```
281+
282+
#### Entitlement Delete
283+
284+
`ENTITLEMENT_DELETE` is sent when an [entitlement](/docs/resources/entitlement) is deleted. Refer to the [Monetization documentation](/docs/monetization/overview) for details.
285+
286+
###### Entitlement Delete Structure
287+
288+
The inner payload is an [entitlement](/docs/resources/entitlement#entitlement-object) object.
289+
290+
###### Entitlement Delete Example
291+
292+
```json
293+
{
294+
"version": 1,
295+
"application_id": "1234560123453231555",
296+
"type": 1,
297+
"event": {
298+
"type": "ENTITLEMENT_DELETE",
299+
"timestamp": "2024-10-18T18:41:21.109604",
300+
"data": {
301+
"application_id": "1234560123453231555",
302+
"consumed": false,
303+
"deleted": true,
304+
"gift_code_flags": 0,
305+
"id": "1234505980407808808",
306+
"promotion_id": null,
307+
"sku_id": "123489045643835123",
308+
"type": 4,
309+
"user_id": "111178765189277770"
310+
}
311+
}
312+
}
313+
```
314+
247315
#### Quest User Enrollment
248316

249317
:::warn

0 commit comments

Comments
 (0)