Skip to content

Document entitlement update & delete webhook events #7919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document entitlement update & delete webhook events #7919

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions docs/events/webhook-events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,8 @@ The "Value" column corresponds to the event's `type` field value in the [event b
| [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 |
| [Application Deauthorized](/docs/events/webhook-events#application-deauthorized) | `APPLICATION_DEAUTHORIZED` | Sent when an app was deauthorized by a user |
| [Entitlement Create](/docs/events/webhook-events#entitlement-create) | `ENTITLEMENT_CREATE` | Entitlement was created |
| [Entitlement Update](/docs/events/webhook-events#entitlement-update) | `ENTITLEMENT_UPDATE` | Entitlement was updated |
| [Entitlement Delete](/docs/events/webhook-events#entitlement-delete) | `ENTITLEMENT_DELETE` | Entitlement was deleted |
| [Quest User Enrollment](/docs/events/webhook-events#quest-user-enrollment) | `QUEST_USER_ENROLLMENT` | User was added to a Quest (currently unavailable) |
| [Lobby Message Create](/docs/events/webhook-events#lobby-message-create) | `LOBBY_MESSAGE_CREATE` | Sent when a message is created in a lobby |
| [Lobby Message Update](/docs/events/webhook-events#lobby-message-update) | `LOBBY_MESSAGE_UPDATE` | Sent when a message is updated in a lobby |
Expand Down Expand Up @@ -244,6 +246,72 @@ The inner payload is an [entitlement](/docs/resources/entitlement#entitlement-ob
}
```

#### Entitlement Update

`ENTITLEMENT_UPDATE` is sent when an [entitlement](/docs/resources/entitlement) is updated. Refer to the [Monetization documentation](/docs/monetization/overview) for details.

###### Entitlement Update Structure

The inner payload is an [entitlement](/docs/resources/entitlement#entitlement-object) object.

###### Entitlement Update Example

```json
{
"version": 1,
"application_id": "1234560123453231555",
"type": 1,
"event": {
"type": "ENTITLEMENT_UPDATE",
"timestamp": "2024-10-18T18:41:21.109604",
"data": {
"application_id": "1234560123453231555",
"consumed": false,
"deleted": false,
"gift_code_flags": 0,
"id": "1234505980407808808",
"promotion_id": null,
"sku_id": "123489045643835123",
"type": 4,
"user_id": "111178765189277770"
}
}
}
```

#### Entitlement Delete

`ENTITLEMENT_DELETE` is sent when an [entitlement](/docs/resources/entitlement) is deleted. Refer to the [Monetization documentation](/docs/monetization/overview) for details.

###### Entitlement Delete Structure

The inner payload is an [entitlement](/docs/resources/entitlement#entitlement-object) object.

###### Entitlement Delete Example

```json
{
"version": 1,
"application_id": "1234560123453231555",
"type": 1,
"event": {
"type": "ENTITLEMENT_DELETE",
"timestamp": "2024-10-18T18:41:21.109604",
"data": {
"application_id": "1234560123453231555",
"consumed": false,
"deleted": true,
"gift_code_flags": 0,
"id": "1234505980407808808",
"promotion_id": null,
"sku_id": "123489045643835123",
"type": 4,
"user_id": "111178765189277770"
}
}
}
```

#### Quest User Enrollment

:::warn
Expand Down