Updated Graphql node documentation for websocket functionality addition for n8n PR #17207

[antman1p]

Update GraphQL node documentation to include WebSocket functionality

Summary

This PR updates the GraphQL node documentation to include the new WebSocket functionality that was added in PR #17207.

Changes Made

Added New Sections:

• Connection Mode: Explanation of HTTP vs WebSocket modes
• WebSocket-specific parameters: Connection timeout, subscription timeout, and subprotocol options
• WebSocket Usage Examples: Real-time subscription examples and connection setup details

Updated Existing Sections:

• Node parameters: Added Connection Mode selection and updated URL parameter to specify https:// vs wss:// protocols
• Authentication: Clarified that authentication options are only available for HTTP mode
• Request Format: Moved to HTTP-only section with better format recommendations
• Related resources: Added link to GraphQL over WebSocket Protocol documentation

Key Features Documented:

• Connection Mode Selection: Choose between HTTP (existing) and WebSocket (new) modes
• WebSocket Protocol Support: Documents support for graphql-transport-ws, graphql-ws, and legacy graphql protocols
• Real-time Subscriptions: Explains how to use WebSocket mode for live data updates
• Comprehensive Configuration: Documents WebSocket URL, timeouts, SSL settings, headers, variables, and operation names
• Error Handling: References the robust error handling implemented in the node

Related PR

• n8n-io/n8n#17207 - Feature: GraphQL WebSocket mode

---

Note

Updates GraphQL node docs to add WebSocket subscription mode with related parameters, clarify HTTP vs WebSocket usage, and include examples.

• Docs: GraphQL node (docs/integrations/builtin/core-nodes/n8n-nodes-base.graphql.md)
  • Connection modes: Add HTTP vs WebSocket modes, with URL guidance (https:// vs wss://).
  • WebSocket-specific params: Connection timeout, subscription timeout, and subprotocols (graphql-transport-ws, graphql-ws, graphql).
  • Parameters updates:
    • Rename/clarify Endpoint to URL and add protocol-specific notes.
    • Authentication clarified as HTTP-only.
    • Add Variables and Operation Name (HTTP POST JSON and WS contexts as applicable).
    • Ignore SSL Issues moved/clarified; headers section retained.
    • Response Format details and Response Data Property Name for string output.
  • HTTP-only request format: Recommend JSON; note raw GraphQL option.
  • Examples: Add WebSocket subscription usage and connection handling notes.
  • Related resources: Add GraphQL over WebSocket protocol link.

^{Written by Cursor Bugbot for commit 39fd841. This will update automatically on new commits. Configure here.}

[netlify]

✅ Deploy Preview for n8n-docs ready!

Name	Link
🔨 Latest commit	52db70a
🔍 Latest deploy log	https://app.netlify.com/projects/n8n-docs/deploys/68f1d3c169e4f50008999d6b
😎 Deploy Preview	https://deploy-preview-3351--n8n-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[imchairmanm]

Thanks @antman1p! We'll hold off on reviewing this until the PR is ready to go in the main repo.