Subscribe To Matchmaking Resource

Subscribe to match resource notifications.

Error codes

This operation may return the following PlayFab errors:

Error	Code
MatchmakingAttributeInvalid	2046
MatchmakingBadRequest	2059
MatchmakingEntityInvalid	2001
MatchmakingTicketNotFound	2018
MatchmakingUnauthorized	2056
PubSubConnectionHandleInvalid	2503
PubSubConnectionNotFoundForEntity	2502
PubSubSubscriptionLimitExceeded	2504

POST

Match

SubscribeToMatchmakingResource

Subscribe To Matchmaking Resource

curl --request POST \
  --url https://{titleId}.playfabapi.com/Match/SubscribeToMatchmakingResource \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Type": "MatchTicketStatusChange",
  "ResourceId": "5a58afee-a9d7-4a47-875b-48bae4dc0590",
  "SubscriptionVersion": 1,
  "PubSubConnectionHandle": "PubSubConnection",
  "EntityKey": {}
}
'

import requests

url = "https://{titleId}.playfabapi.com/Match/SubscribeToMatchmakingResource"

payload = {
    "Type": "MatchTicketStatusChange",
    "ResourceId": "5a58afee-a9d7-4a47-875b-48bae4dc0590",
    "SubscriptionVersion": 1,
    "PubSubConnectionHandle": "PubSubConnection",
    "EntityKey": {}
}
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({
    Type: 'MatchTicketStatusChange',
    ResourceId: '5a58afee-a9d7-4a47-875b-48bae4dc0590',
    SubscriptionVersion: 1,
    PubSubConnectionHandle: 'PubSubConnection',
    EntityKey: {}
  })
};

fetch('https://{titleId}.playfabapi.com/Match/SubscribeToMatchmakingResource', 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/Match/SubscribeToMatchmakingResource",
  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([
    'Type' => 'MatchTicketStatusChange',
    'ResourceId' => '5a58afee-a9d7-4a47-875b-48bae4dc0590',
    'SubscriptionVersion' => 1,
    'PubSubConnectionHandle' => 'PubSubConnection',
    'EntityKey' => [
        
    ]
  ]),
  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/Match/SubscribeToMatchmakingResource"

	payload := strings.NewReader("{\n  \"Type\": \"MatchTicketStatusChange\",\n  \"ResourceId\": \"5a58afee-a9d7-4a47-875b-48bae4dc0590\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {}\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/Match/SubscribeToMatchmakingResource")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Type\": \"MatchTicketStatusChange\",\n  \"ResourceId\": \"5a58afee-a9d7-4a47-875b-48bae4dc0590\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Match/SubscribeToMatchmakingResource")

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  \"Type\": \"MatchTicketStatusChange\",\n  \"ResourceId\": \"5a58afee-a9d7-4a47-875b-48bae4dc0590\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {}\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "Topic": "MatchResourceTopic"
  }
}

{
  "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

Subscribe to match resource notifications. Match subscriptions have two types; MatchInvite and MatchTicketStatusChange

EntityKey

object

required

The entity performing the subscription. The entity must be authorized to use this connectionHandle.

Show child attributes

PubSubConnectionHandle

string

required

Opaque string, given to a client upon creating a connection with PubSub. Notifications will be sent to the connection associated with this handle.

ResourceId

string

required

The name of the resource to subscribe to. It follows the format {queueName}|{ticketId} for MatchTicketStatusChange. For MatchInvite, ResourceId is @me.

SubscriptionVersion

number

required

Version number for the subscription of this resource. Current supported version must be 1.

Type

string

required

Subscription type. MatchInvite subscriptions are per-player. MatchTicketStatusChange subscriptions are per-ticket. Subscribe calls are idempotent. Subscribing on the same resource for the same connection results in success.

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

Example:

{ "Topic": "MatchResourceTopic" }

Last modified on October 1, 2026

⌘I

Subscribe To Matchmaking Resource

curl --request POST \
  --url https://{titleId}.playfabapi.com/Match/SubscribeToMatchmakingResource \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Type": "MatchTicketStatusChange",
  "ResourceId": "5a58afee-a9d7-4a47-875b-48bae4dc0590",
  "SubscriptionVersion": 1,
  "PubSubConnectionHandle": "PubSubConnection",
  "EntityKey": {}
}
'

import requests

url = "https://{titleId}.playfabapi.com/Match/SubscribeToMatchmakingResource"

payload = {
    "Type": "MatchTicketStatusChange",
    "ResourceId": "5a58afee-a9d7-4a47-875b-48bae4dc0590",
    "SubscriptionVersion": 1,
    "PubSubConnectionHandle": "PubSubConnection",
    "EntityKey": {}
}
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({
    Type: 'MatchTicketStatusChange',
    ResourceId: '5a58afee-a9d7-4a47-875b-48bae4dc0590',
    SubscriptionVersion: 1,
    PubSubConnectionHandle: 'PubSubConnection',
    EntityKey: {}
  })
};

fetch('https://{titleId}.playfabapi.com/Match/SubscribeToMatchmakingResource', 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/Match/SubscribeToMatchmakingResource",
  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([
    'Type' => 'MatchTicketStatusChange',
    'ResourceId' => '5a58afee-a9d7-4a47-875b-48bae4dc0590',
    'SubscriptionVersion' => 1,
    'PubSubConnectionHandle' => 'PubSubConnection',
    'EntityKey' => [
        
    ]
  ]),
  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/Match/SubscribeToMatchmakingResource"

	payload := strings.NewReader("{\n  \"Type\": \"MatchTicketStatusChange\",\n  \"ResourceId\": \"5a58afee-a9d7-4a47-875b-48bae4dc0590\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {}\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/Match/SubscribeToMatchmakingResource")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Type\": \"MatchTicketStatusChange\",\n  \"ResourceId\": \"5a58afee-a9d7-4a47-875b-48bae4dc0590\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Match/SubscribeToMatchmakingResource")

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  \"Type\": \"MatchTicketStatusChange\",\n  \"ResourceId\": \"5a58afee-a9d7-4a47-875b-48bae4dc0590\",\n  \"SubscriptionVersion\": 1,\n  \"PubSubConnectionHandle\": \"PubSubConnection\",\n  \"EntityKey\": {}\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "Topic": "MatchResourceTopic"
  }
}

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

PlayFab API

PlayFab REST API References

Subscribe To Matchmaking Resource

Error codes

Authorizations

Body

Response