zelo72/documentation
1
0
Fork 0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
Code Issues 6 Releases Wiki Activity

Document Authorization header for WebSocket API (#1576)

Browse Source 
Fixes #1575

Co-authored-by: Bastian Blank <waldi@debian.org>
This commit is contained in:
Bastian 2024-12-19 08:57:37 +01:00 committed by GitHub
parent 5c792e83d9
commit c7d6167dbc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
content/en/methods/streaming.md
View File

@ -600,6 +600,12 @@ wss://mastodon.example/api/v1/streaming
Open a multiplexed WebSocket connection to receive events. Open a multiplexed WebSocket connection to receive events.
#### Request
##### Headers
Authorization
: {{<required>}} Provide this header with `Bearer <user_token>` to gain authorized access to this API method.
##### Parameters ##### Parameters
{{< hint style="info" >}} {{< hint style="info" >}}
@ -619,7 +625,7 @@ Example unsubscription from user updates:
{{</hint>}} {{</hint>}}
access_token access_token
: {{<required>}} String. A user-authorized OAuth token. : {{<required>}} String. A user-authorized OAuth token. Alternative to `Authorization` header.
stream stream
: {{<required>}} String. The stream to watch for events. See [Streams](#streams) for possible values. : {{<required>}} String. The stream to watch for events. See [Streams](#streams) for possible values.