Skip to content

Document pins, mentions, blocks and contact preferences on the socket page #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sivert-io merged 1 commit into from
Oct 7, 2026
Merged

Document pins, mentions, blocks and contact preferences on the socket page #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions content/docs/build/server-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,29 @@ signing file links. It's the same shape as `fileKey` above.
| `chat:history` | server → client | Answer to `chat:fetch` |
| `chat:purge_user` | server → client | Everything from one member is gone |
| `chat:merge_user` | server → client | A guest was merged into an account: `{ from_server_user_id, to_server_user_id }` |
| `chat:pin` | client → server | `{ accessToken, conversationId, messageId, pinned }` |
| `chat:pins` | both | Ask with `{ conversationId }`, and the answer comes back on the same name |
| `chat:pinned` | server → client | A message was pinned or unpinned |
| `chat:error` | server → client | |

### Mentions

| Event | Direction | Notes |
|-------|-----------|-------|
| `mentions:list`, `mentions:seen` | client → server | |
| `mentions:list` | server → client | Answer to both, with the unseen mentions and counts per channel and thread |
| `mention:new` | server → client | You were mentioned while connected |

### Blocking, and who can reach you

| Event | Direction | Notes |
|-------|-----------|-------|
| `user:block`, `user:unblock` | client → server | `{ accessToken, serverUserId }` |
| `user:blocks:list` | client → server | |
| `user:blocked`, `user:unblocked`, `user:blocks` | server → client | |
| `contact:prefs:get`, `contact:prefs:set` | client → server | Who may message or call you, `everyone`, `friends` or `nobody` |
| `contact:prefs` | server → client | Answer to both |

### Direct messages

A conversation between two people, or a group. `dm:open` is idempotent — asking
Expand Down
Loading