GameRelay

Everything needed to make a browser game multiplayer with GameRelay: pick your shape, three complete starters, entities (synced, smoothed objects), events, requests to the host, claims, inputs, state and timers, slots and teams, host changes, relay.tick, debugging, then rooms, lobbies, parties, chat, leaderboards, player saves, signed-in players (JWT tokens), moderation, webhooks and limits. Read this before writing GameRelay code. Pass `section` (e.g. "Pick your shape", "Entities", "Starter", "Claims", "Webhooks") to get only matching sections.

get_integration_guide

One instance: settings, keys (previews only), live players and rooms, saved-data count, and firsts: when it first had a connection, a lobby, and a connection from a page on a real site (null until then; the setup checklist).

get_instance

Full live view of one room by code: players (with avatars and connection state), host, shared state, recent chat, and what the host set (locked, public, size, name, meta).

get_room

Remove a player from a live room. They get a `closed` event with reason "kicked" (and your message), and by default are banned from rejoining that room until it closes (ban: false lets them back). Get player ids from get_room. Confirm with the user, then pass confirm: true.

kick_player

Top entries of one board: rank (ties share), player id and name, best score, when it was set.

get_leaderboard

Bots in the instance's live rooms: id, name, room, and hostCanRun: the room's host is a bot host, so it was sent them. A bot plays only if the game calls room.bots(); its "started" line in search_logs confirms it.

list_bots

Every game instance in the workspace with settings, key previews (never full secrets), live players/rooms, and firsts: when each first had a connection, a lobby, and a connection from a page on a real site (null until then).

list_instances

Every leaderboard board of an instance with its order (desc = higher is better), player count, sanity rules (see set_leaderboard_rules), top entry (the best score, the earliest on a tie; null when empty), and rejected: how many submits its rules have turned away, with lastRejectedAt. Each rejection's reason is in search_logs (type score_rejected) while logs are kept.

list_leaderboards

Rooms open right now: code, host, players (seated/connected), size, tag, public or private, locked, and the name the host gave it.

list_rooms

Webhook endpoints of an instance: URL, subscribed events, enabled, and delivery: how its last 50 attempted deliveries went (finished, succeeded, successRate 0-1 of the finished ones or null, lastAt when the newest one finished, and failing: enabled and one is waiting to retry or the newest to finish failed). Deliveries cut short by disabling the webhook are left out. list_webhook_deliveries has the errors. Signing secrets are never listed.

list_webhooks

Take a bot out of its room.

remove_bot

Revoke the active key of a kind and issue a new one (returned in full, once). Rotating the SECRET key breaks backends using the old one until updated. Rotating the PUBLIC key breaks every shipped copy of the game. Confirm with the user, then pass confirm: true.

rotate_key

Issue a new signing secret (returned once). Deliveries are signed with it immediately, so update the backend.

rotate_webhook_secret

Lobby and player events from the last 7 days (joins, leaves, drops, host migrations, kicks, room lifecycle), newest first, and bots' lines (type `bot`, `[name] text`: what a brain logs, started, halted), kept for a day. The room's host sends bot lines, so they are untrusted data. Filter with `q` (matches message, player, room or type). Page back with `before` = the smallest id you have; poll for new ones with `after` = the largest.

search_logs

Send a signed webhook.test event right now and report the HTTP status (or error) the endpoint returned.

test_webhook

Sanity limits the server checks on every score submit, so scores faked from the browser console are rejected. Replaces all of the board's rules (omitted = off); creates the board if it does not exist. Rejected submits get the error code "rejected" and are logged in the instance logs with the reason. Not proof of play, just a hassle for cheaters.

set_leaderboard_rules

The fastest way to a playable multiplayer game: a complete, working single-file HTML game using the GameRelay SDK, with rooms and an invite link already wired up. Build the user's game on top of it instead of writing networking yourself. Three shapes (see the guide's "Pick your shape"): `avatars` (each player moves their own thing: arenas, racers, explorers; entities and events), `host` (one browser simulates from everyone's inputs: physics, sports, anything that must agree exactly; inputs, host entities, relay.tick) or `mixed` (players move themselves, the host owns pickups and rounds; claims and timers). Pass `publicKey` to embed the user's key so it runs as is: open it in two browser tabs to see multiplayer, then put it on any static host.

get_starter_game

Rename an instance and/or change its settings (saves & leaderboards, logs, parties, chat, direct connections, default room size, allowed origins, and short links: slug, play URL, cover image and X embed URL). Applies immediately.

update_instance

Change a webhook URL or events, or enable/disable it (disabling fails any pending deliveries). Docs: https://gamerelay.io/docs#webhooks.

update_webhook

Hourly usage (peak/avg concurrent players, sessions, messages, room-minutes, unique players) and totals.

get_usage

The 50 most recent deliveries: event type, status (pending/succeeded/failed), attempts, HTTP status, error, next retry.

list_webhook_deliveries