WebSocket Guides#381
Merged
Merged
Conversation
✅ Deploy Preview for caido-documentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 79.2%, saving 669.3 KB.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds new how-to guides documenting WebSocket support introduced in v0.57.0 (Replay WebSocket sessions and Match & Replace for WebSocket messages), and updates navigation/wording to distinguish HTTP Replay guidance from WebSocket Replay guidance.
Changes:
- Added a new Replay guide for creating WebSocket sessions and sending messages.
- Added a new Match & Replace guide for tampering with WebSocket messages and viewing the result in WS History.
- Updated the Replay requests guide/title and the Guides sidebar to reflect the new HTTP vs WebSocket split.
Reviewed changes
Copilot reviewed 4 out of 11 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/app/guides/replay_websocket.md | New how-to guide for creating a Replay WebSocket session and sending messages. |
| src/app/guides/replay_requests.md | Renames the guide to explicitly cover HTTP Replay and adds a manual session creation note. |
| src/app/guides/match_replace_websocket.md | New how-to guide for applying Match & Replace rules to WebSocket traffic and viewing tampered output. |
| .vitepress/sidebars/app/guides.ts | Adds the two new guides to the sidebar and updates the Replay HTTP guide label. |
Comment on lines
+5
to
8
| # Sending HTTP Requests to Replay | ||
|
|
||
| ::: tip <code><Icon icon="fas fa-video" /></code> Video Demonstration | ||
| --- |
|
|
||
| To send a WebSocket message in Replay, **click** on the <code><Icon icon="fas fa-chevron-down" /></code> attached to the `+ New Session` button and select <code><Icon icon="fas fa-arrow-right-arrow-left" /> WebSocket</code>. | ||
|
|
||
| <img alt="Creating a new WebSocket Replaysession." src="/_images/replay_websocket.png" center width=350> |
|
|
||
| # Modifying WebSocket Messages | ||
|
|
||
| To modify an outgoing or incoming WebSocket message, **click** on the `Section` drop-down menu and select either `Request Websocket` or `Response Websocket`. |
Corb3nik
approved these changes
Jun 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #367 & #374