AsyncAPI channel · Photon Engine
· Photon Realtime Transport Protocol over WebSocket
/photon/ws
Single duplex WebSocket connection used for the entire Photon session
against whichever server role (Name Server, Master Server, or Game
Server) the client currently addresses. There is no per-message-type
URL path in the real protocol; this channel represents the one
long-lived socket carrying every operation request, operation
response, and event for the connection's lifetime.
Client-to-server request identified by an operation code.
Content-Type: application/octet-stream
OperationResponse
Server-to-client reply to a specific operation code.
Content-Type: application/octet-stream
EventData
Server-pushed event identified by an event code.
Content-Type: application/octet-stream
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.