docs: add websocket authentication and generic handler documentation#746
Open
docs: add websocket authentication and generic handler documentation#746
Conversation
New pages: - WebSocket Authentication guide: config, token flow, delivery methods, telephony intermediary pattern - Generic WebSocket guide: endpoint format, auth modes, when to use Updates: - deploy.mdx: add websocket_auth to pcc-deploy.toml reference - security-and-compliance.mdx: add WebSocket Security section - openapi-start.json: add "websocket" transport, token/wsUrl response fields - docs.json: register new pages in navigation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Default is now "none" (opt-in to auth), not "token" - Replace intermediary server pattern with Twilio Function example showing how to call /start directly from the webhook handler - Remove old/new service default distinction (all default to none)
markbackman
reviewed
Apr 21, 2026
| @@ -0,0 +1,87 @@ | |||
| --- | |||
| title: Telephony Overview | |||
Contributor
There was a problem hiding this comment.
Added this new guide to help tie together the telephony section. It's not related to the change, but was a good opportunity to add it.
markbackman
reviewed
Apr 21, 2026
| @@ -0,0 +1,55 @@ | |||
| --- | |||
| title: Generic WebSocket | |||
Contributor
There was a problem hiding this comment.
This is a new top-level page highlighting the generic websocket endpoint.
I'm keeping this separate from the auth page since we're linking to the auth page from a few places.
The generic WebSocket endpoint isn't telephony-specific — it also supports server-to-server and custom client integrations. Move it to a top-level guide and group it with websocket-authentication in the sidebar. Add a Pipecat Cloud telephony overview that compares the WebSocket providers, generic fallback, and Daily PSTN options so readers land somewhere orienting instead of Twilio by default. Redirect the old URL to keep existing links working.
markbackman
force-pushed
the
ms/generic-websockets-handler-hmac-auth
branch
from
e0a0a8e to
c12f017
Compare
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
2 participants
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.
New pages:
Updates: