SSE ClientInstall

Summary

Connect to a specified Server-Sent Events (SSE) endpoint URL, optionally authenticate and send custom headers, collect streaming SSE events until a stop condition or limits are reached, and output the collected events as JSON objects.

Inputs

• URL (required) — The SSE endpoint URL to connect to, supporting n8n expressions.
• Authentication — Authentication method for the SSE endpoint: None, Anthropic API Key, Bearer Auth, or Header Auth (API Key).
• Send Custom Headers — Whether to send additional custom HTTP headers.
• Specify Headers — Define custom headers either as key-value pairs or JSON object when sending custom headers.
• Header Parameters — Key-value pairs for custom headers when specifying them as fields.
• Headers (JSON) — Custom headers as a JSON object when specifying them as JSON.
• Stop Event Type — Regex pattern on the SSE event type field that stops event collection when matched.
• Stop Data Pattern — Regex pattern on the SSE event data field that stops event collection when matched.
• Include Stop Event — Whether to include the event that triggered the stop condition in the output.
• Options — Additional options such as timeout (ms), retry attempts, retry delay, include metadata, max events to collect, filter event types regex, HTTP method (GET or POST), and request body (for POST).

Output shape

a list of JSON objects each representing a collected SSE event

Each output item contains parsed JSON data if possible; otherwise raw data under 'data'. Includes optional $metadata ($metadata includes eventType, lastEventId, ISO timestamp, and origin URL) if enabled. Events are collected until a stop condition based on event type or data pattern, max events reached, timeout, or workflow cancellation. Request retries occur on network errors except client HTTP 4xx errors, respecting retry attempts and delay.

Links

• n8n community nodes installation guide