Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Commit c40a58d

Browse files
committed
Define identify event
1 parent 4b60f1e commit c40a58d

File tree

1 file changed

+19
-1
lines changed
  • docs/Protocol Specifications

1 file changed

+19
-1
lines changed

docs/Protocol Specifications/core.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,25 @@ in milliseconds at which the client should send heartbeat events to the server.
335335
The "identify" event is sent by the client to the server to let the server know which actor the
336336
client is.
337337

338-
TODO
338+
!!! example "Example identify event payload"
339+
340+
```json
341+
{
342+
"n": "core",
343+
"op": 2,
344+
"d": {
345+
"token": "a9144379a161e1fcf6b07801b70db6d6c481..."
346+
}
347+
}
348+
```
349+
350+
| Field | Type | Description |
351+
| ------- | ------ | --------------------------------------------------------------------------------------------------------------------- |
352+
| `token` | string | A [session token](#41-authentication) issued by the server, identifying the session the client wants to connect with. |
353+
354+
!!! info
355+
356+
This event may be extended in a backwards-compatible manner in future versions of polyproto.
339357

340358
##### 3.2.3.3 Service channels
341359

0 commit comments

Comments
 (0)