diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2025-04-10 20:50:13 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2025-04-10 20:50:13 -0400 |
| commit | 1ef57107b1c355ef896327f0714344277df7ae18 (patch) | |
| tree | 9874d3d61f0bdb13913c6c4d079fbb82b336f656 /docs/api/boot.md | |
| parent | 0fc3057b05dddb4eba142deeb6373ed37e312c60 (diff) | |
| parent | 1ee129176eb71f5e246462b66fd9c9862ed1ee7a (diff) | |
Use a heartbeat to allow the client to reconnect after network failures.
Diffstat (limited to 'docs/api/boot.md')
| -rw-r--r-- | docs/api/boot.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/api/boot.md b/docs/api/boot.md index 0c2dc08..46b972f 100644 --- a/docs/api/boot.md +++ b/docs/api/boot.md @@ -42,6 +42,7 @@ This endpoint will respond with a status of "id": "U1234abcd" }, "resume_point": 1312, + "heartbeat": 30, "users": [ { "id": "U1234abcd", @@ -72,6 +73,7 @@ The response will include the following fields: |:---------------|:----------------|:-------------------------------------------------------------------------------------------------------------------------| | `user` | object | The details of the caller's identity. | | `resume_point` | integer | A resume point for [events](./events.md), such that the event stream will begin immediately after the included snapshot. | +| `heartbeat` | integer | The [heartbeat timeout](./events.md#heartbeat-events), in seconds, for events. | | `users` | array of object | A snapshot of the users present in the service. | | `channels` | array of object | A snapshot of the channels present in the service. | | `messages` | array of object | A snapshot of the messages present in the service. | |