Skip to content

wss://

TLS WebSocket client. Sibling of ws:// — same parameter surface, same body shape, same header conventions. TLS is auto-enabled (default port 443).

URI shape

wss://host[:port][/path]?…

All other params are identical to ws://.

YAML example

workflows:
  - id: wss-feed
    description: Stream from a TLS WebSocket endpoint.
    trigger:
      uri: wss://api.example.com:443/feed
      params:
        consumeAsClient: "true"
        clientSubProtocols: "v1.stream"
        # Use canonical Helix TLS keys to pin a CA / require mTLS.
        tlsCA: /etc/ssl/certs/ca.crt
        tlsCert: /etc/ssl/client.crt
        tlsKey: /etc/ssl/client.key
    steps:
      - log:
          message: "${body}"

See also

  • ws:// — same component, plain-text sibling.