versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2026-03-13 10:59:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: ✨ Document inbox endpoint
Some checks failed
Mirror to Codeberg / Mirror (push) Failing after 0s
Details

Browse source
This commit is contained in:
Jesse Wierzbinski 2025-05-02 15:31:04 +02:00
parent 71064dea2c
commit 51c53824ad
No known key found for this signature in database
2 changed files with 64 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

36
app/api/endpoints/page.mdx
View file

@ -148,3 +148,39 @@ GET /.versia/v0.6/entities/user/1234/collections/followers?offset=10&limit=20
Host: b.social
Accept: application/vnd.versia+json
```
## Inbox
The inbox endpoint is used for other instances to send entities to this instance. It is a single endpoint that can receive messages for every user (also known as a shared inbox).
The delivery mechanism is described further in the [Federation](/federation) document.
<Row>
<Col>
<Properties name="Inbox">
<Property name="endpoint">
Must be `/.versia/v0.6/inbox`.
</Property>
<Property name="method">
Must be `POST`.
</Property>
</Properties>
</Col>
<Col sticky>
```http {{ 'title': 'Example request' }}
POST /.versia/v0.6/inbox
Host: b.social
Accept: application/vnd.versia+json
Content-Type: application/vnd.versia+json
{
"type": "Note",
"id": "1234",
...
}
```
</Col>
</Row>