Session modes
The mode field decides which key can create the session, whether webhooks fire, and which pool of players it can match against.
live
Production
Requires bg_live_. Real user IDs. Tenant-isolated matchmaking. Webhooks fire.
test
Sandbox
Requires bg_test_. Real user IDs, tenant-isolated, but no webhooks — safe for CI.
training
Guest / anonymous
Requires bg_live_. Player IDs are auto-generated. Cross-tenant practice pool, no webhooks.
Comparison
| Mode | Can match with | Player IDs | Webhooks |
|---|---|---|---|
| live | Same tenant, live sessions only | Your own user IDs | Yes |
| test | Same tenant, test sessions only | Your own user IDs | No |
| training | Any tenant, training pool | Server-generated, anonymous | No |
For a
training session you pass playerCount instead of a players[] array — the service invents anonymous identities on your behalf.