Skip to content

Commit

Permalink
Document Authorization header for WebSocket API (#1576)
Browse files Browse the repository at this point in the history
Fixes #1575

Co-authored-by: Bastian Blank <waldi@debian.org>
  • Loading branch information
waldiTM and Bastian Blank authored Dec 19, 2024
1 parent 5c792e8 commit c7d6167
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion content/en/methods/streaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,12 @@ wss://mastodon.example/api/v1/streaming

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

{{< hint style="info" >}}
Expand All @@ -619,7 +625,7 @@ Example unsubscription from user updates:
{{</hint>}}

access_token
: {{<required>}} String. A user-authorized OAuth token.
: {{<required>}} String. A user-authorized OAuth token. Alternative to `Authorization` header.

stream
: {{<required>}} String. The stream to watch for events. See [Streams](#streams) for possible values.
Expand Down

0 comments on commit c7d6167

Please sign in to comment.