Passer au contenu principal
POST
Subscribe To Lobby Resource

Autorisations

X-EntityToken
string
header
requis

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Corps

application/json

Request to subscribe to lobby resource notifications.

Request to subscribe to lobby resource notifications.

EntityKey
object
requis

The entity performing the subscription.

PubSubConnectionHandle
string
requis

Opaque string, given to a client upon creating a connection with PubSub.

ResourceId
string
requis

The name of the resource to subscribe to. For LobbyChange subscriptions this is the lobbyId. For LobbyInvite subscriptions this should always be "@me".

SubscriptionVersion
number
requis

Version number for the subscription of this resource.

Type
enum<string>
requis

Subscription type. "LobbyChange" subscriptions allow a member or owner to receive notifications of lobby data, member or owner changes. "LobbyInvite" subscriptions allow a player to receive invites to lobbies. A player does not need to be a member of a lobby to receive lobby invites.

Options disponibles:
LobbyChange,
LobbyInvite
CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Réponse

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Dernière modification le 6 octobre 2026