Hathora lobby creation endpoint
InfoGeneratePackages
This is the documentation for the Hathora lobby creation endpoint
for the url: https://api.hathora.dev/lobby/v3/{appId}/create
CreateLobby
Create a new lobby for an application. A lobby object is a wrapper around a room object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players.
AUTHORIZATIONS:
playerAuth
PATH PARAMETERS
appId
required
string (AppId)
Example: app-af469a92-5b45-4565-b3c4-b79878de67d2
System generated unique identifier for an application.
QUERY PARAMETERS
shortCode
string (ShortCode) <= 100 characters
Example: shortCode=LFG4
User-defined identifier for a lobby.
roomId
string (RoomId) [ 1 .. 100 ] characters ^[a-zA-Z0-9_-]*$
Example: roomId=2swovpy1fnunu
Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be returned if roomId is not globally unique.
REQUEST BODY SCHEMA: application/json
required
visibility
required
string (LobbyVisibility)
Enum: "private" "public" "local"
Types of lobbies a player can create.
private: the player who created the room must share the roomId with their friends
public: visible in the public lobby list, anyone can join
local: for testing with a server running locally
roomConfig
string (RoomConfig) <= 10000 characters
Optional configuration parameters for the room. Can be any string including stringified JSON. It is accessible from the room via GetRoomInfo().
region
required
string (Region)
Enum: "Seattle" "Los_Angeles" "Washington_DC" "Chicago" "London" "Frankfurt" "Mumbai" "Singapore" "Tokyo" "Sydney" "Sao_Paulo" "Dallas"
Try a prompt