Protocol reference

This reference lists every message that passes between an Ankor node and a controller, with its fields and an example. For how the connection works and where to start, read the protocol overview first.

Types used by several messages are collected on the Types & Values page. To generate code, the whole reference is also available as asyncapi.yaml, an AsyncAPI 3.1 document.

Agent socket

Everything sent over the WebSocket each node keeps open: what the agent reports, the requests your controller sends, and their replies.

• Agent socket: Every message on the agent's WebSocket, both ways.

Event upload

The HTTP request that delivers gameplay events in batches, the answers your controller gives, and every gameplay event a batch can carry, grouped by what happens in the game.

• Event upload: Gameplay events uploaded over HTTP.

Plugin socket

The local socket inside a node between each game server's plugin and the agent.

• Plugin socket: Every message between a game server's plugin and its agent, both ways.