Back to Nodes

WebSocket Stream

Last updated Feb 11, 2025

A production-ready custom node for continuously streaming data from a WebSocket connection

3 Weekly Downloads
13 Monthly Downloads

Included Nodes

WebSocket Stream

Description

n8n-nodes-websocket-stream-node

A production-ready custom node for streaming data continuously from a WebSocket connection. This node establishes a persistent WebSocket connection and emits each incoming message to the workflow.

Features

  • Continuous Streaming: Maintains an open WebSocket connection and streams each incoming message as a workflow item.
  • Automatic Reconnection: Optionally reconnects if the connection closes or errors out.
  • Strict Type Checking: Built with TypeScript using strict compiler settings.
  • Type Declarations & Source Maps: Generates declaration files and source maps for improved developer experience.
  • Community Node Format: Configured to work with the standard file layout (nodes and credentials folders) expected by community nodes.

Installation

Install the package from npm:

npm install n8n-nodes-websocket-stream-node

May need to add the following with uploading to npm via Codespace

pnpm add -D @types/ws @types/node