Docs/Hosted Matchmaking/Endpoints Reference
Hosted Matchmaking

Endpoints reference

Six endpoints, all REST — every one below can actually be called from this page. Use a bg_test_ key.

Create a ticket

POST/matchmaking/hosted/ticket?game=checkers

Starts a forming, empty ticket for one game. Returns ticketId.

Add a player to a ticket

POST/matchmaking/hosted/ticket/:id/players?game=checkers

Adds one currently-connected player, by id, to a specific forming ticket.

Promote a ticket

POST/matchmaking/hosted/ticket/:id/promote?game=checkers

Marks a forming ticket as ready — makes it visible via GET /pool and eligible for start-match. Never automatic.

Submit a pre-formed group

POST/matchmaking/hosted/submit-group?game=checkers

One-shot alternative to the ticket lifecycle — submit every playerId at once.

Start a match

POST/matchmaking/hosted/start-match?game=checkers

Fires a match right now from one or more promoted/submitted groups in your tenant's pool.

Inspect the pool

GET/matchmaking/hosted/pool?game=checkers

Read-only — current pool state for your tenant. No mutation, no side effect.