Skip to content

Conversation

antman1p
Copy link

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

Copy link

netlify bot commented Jul 13, 2025

Deploy Preview for n8n-docs ready!

Name Link
🔨 Latest commit 512cf7a
🔍 Latest deploy log https://app.netlify.com/projects/n8n-docs/deploys/68d5574292b2d300081adb51
😎 Deploy Preview https://deploy-preview-3351--n8n-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

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
Copy link

CLAassistant commented Jul 13, 2025

CLA assistant check
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 imchairmanm added the pending-dev Blocked pending merge of related dev PR label Jul 14, 2025
@imchairmanm
Copy link
Contributor

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

@StarfallProjects StarfallProjects added the community-contribution Potential community contribution label Aug 13, 2025
cursor[bot]

This comment was marked as outdated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Potential community contribution pending-dev Blocked pending merge of related dev PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants