Docs: Document streaming differences
authorlain <lain@soykaf.club>
Fri, 29 May 2020 14:03:55 +0000 (16:03 +0200)
committerlain <lain@soykaf.club>
Fri, 29 May 2020 14:03:55 +0000 (16:03 +0200)
docs/API/differences_in_mastoapi_responses.md

index e65fd5da403ecf61f579decfa1039889ab629252..a9d1f2f388860a68b5b9c92eaa1579bd4e0d5cd1 100644 (file)
@@ -226,3 +226,7 @@ Has theses additional parameters (which are the same as in Pleroma-API):
 Has these additional fields under the `pleroma` object:
 
 - `unread_count`: contains number unread notifications
+
+## Streaming
+
+There is an additional `user:pleroma_chat` stream. Incoming chat messages will make the current chat be sent to this `user` stream. The `event` of an incoming chat message is `pleroma:chat_update`. The payload is the updated chat with the incoming chat message in the `last_message` field.