Subscribe To Lobby Resource

Subscribe to lobby resource notifications.

Allowed entity token types: game_server, title_player_account

Error codes

This operation may return the following PlayFab errors:

Error	Code
LobbyBadRequest	13007
LobbyDoesNotExist	13000
LobbyRateLimitExceeded	13001
PubSubConnectionHandleInvalid	2503
PubSubConnectionNotFoundForEntity	2502
PubSubSubscriptionLimitExceeded	2504

POST

Lobby

SubscribeToLobbyResource

Subscribe To Lobby Resource

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "ResourceId": "5c905725-0184-4112-a563-2f4187710d06",
  "SubscriptionVersion": 1,
  "PubSubConnectionHandle": "PubSubConnection",
  "EntityKey": {
    "Id": "1234",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource"

payload = {
    "ResourceId": "5c905725-0184-4112-a563-2f4187710d06",
    "SubscriptionVersion": 1,
    "PubSubConnectionHandle": "PubSubConnection",
    "EntityKey": {
        "Id": "1234",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
    }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ResourceId: '5c905725-0184-4112-a563-2f4187710d06',
    SubscriptionVersion: 1,
    PubSubConnectionHandle: 'PubSubConnection',
    EntityKey: {Id: '1234', Type: 'title_player_account', TypeString: 'title_player_account'}
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ResourceId' => '5c905725-0184-4112-a563-2f4187710d06',
    'SubscriptionVersion' => 1,
    'PubSubConnectionHandle' => 'PubSubConnection',
    'EntityKey' => [
        'Id' => '1234',
        'Type' => 'title_player_account',
        'TypeString' => 'title_player_account'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource"

	payload := strings.NewReader("{\n  \"ResourceId\": \"5c905725-0184-4112-a563-2f4187710d06\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {\n    \"Id\": \"1234\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ResourceId\": \"5c905725-0184-4112-a563-2f4187710d06\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {\n    \"Id\": \"1234\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ResourceId\": \"5c905725-0184-4112-a563-2f4187710d06\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {\n    \"Id\": \"1234\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {
    "Topic": "<string>"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Authorizations

X-EntityToken

string

header

required

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

Body

application/json

Request to subscribe to lobby resource notifications.

EntityKey

object

required

The entity performing the subscription.

Show child attributes

PubSubConnectionHandle

string

required

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

ResourceId

string

required

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

required

Version number for the subscription of this resource.

Type

enum<string>

required

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.

Available options:

LobbyChange,

LobbyInvite

CustomTags

object

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

Response

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

Show child attributes

Last modified on October 1, 2026

⌘I

Subscribe To Lobby Resource

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "ResourceId": "5c905725-0184-4112-a563-2f4187710d06",
  "SubscriptionVersion": 1,
  "PubSubConnectionHandle": "PubSubConnection",
  "EntityKey": {
    "Id": "1234",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource"

payload = {
    "ResourceId": "5c905725-0184-4112-a563-2f4187710d06",
    "SubscriptionVersion": 1,
    "PubSubConnectionHandle": "PubSubConnection",
    "EntityKey": {
        "Id": "1234",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
    }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ResourceId: '5c905725-0184-4112-a563-2f4187710d06',
    SubscriptionVersion: 1,
    PubSubConnectionHandle: 'PubSubConnection',
    EntityKey: {Id: '1234', Type: 'title_player_account', TypeString: 'title_player_account'}
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ResourceId' => '5c905725-0184-4112-a563-2f4187710d06',
    'SubscriptionVersion' => 1,
    'PubSubConnectionHandle' => 'PubSubConnection',
    'EntityKey' => [
        'Id' => '1234',
        'Type' => 'title_player_account',
        'TypeString' => 'title_player_account'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource"

	payload := strings.NewReader("{\n  \"ResourceId\": \"5c905725-0184-4112-a563-2f4187710d06\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {\n    \"Id\": \"1234\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ResourceId\": \"5c905725-0184-4112-a563-2f4187710d06\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {\n    \"Id\": \"1234\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Lobby/SubscribeToLobbyResource")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ResourceId\": \"5c905725-0184-4112-a563-2f4187710d06\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {\n    \"Id\": \"1234\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {
    "Topic": "<string>"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Subscribe To Lobby Resource

Error codes

Authorizations

Body

Response