Skip to content

[Doc] Update websocket docs to suggest passing the token as headers rather than query parameters #981

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[Doc] Update websocket docs to suggest passing the token as headers rather than query parameters #981

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f83af9f
suggest passing the token as headers
walkinggo Dec 23, 2024
365bff3
Merge branch 'main' into main
walkinggo Jan 15, 2025
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
1 change: 1 addition & 0 deletions docs/client-libraries-websocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ All exchanges via the WebSocket API use JSON.
### Authentication

#### Browser javascript WebSocket client
> For security reasons, we suggest passing the token as headers rather than as query parameters.

Use the query param `token` to transport the authentication token.

Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-3.0.x/client-libraries-websocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ All exchanges via the WebSocket API use JSON.
### Authentication

#### Browser javascript WebSocket client
> For security reasons, we suggest passing the token as headers rather than as query parameters.

Use the query param `token` to transport the authentication token.

Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-4.0.x/client-libraries-websocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ All exchanges via the WebSocket API use JSON.
### Authentication

#### Browser javascript WebSocket client
> For security reasons, we suggest passing the token as headers rather than as query parameters.

Use the query param `token` to transport the authentication token.

Expand Down