Connect

websocket

Connects to a websocket server and continuously receives messages.

It is possible to configure an open_message, which when set to a non-empty string will be sent to the websocket server each time a connection is first established.

Common
Advanced

input:
  label: ""
  websocket:
    url: "" # No default (required)
    auto_replay_nacks: true

input:
  label: ""
  websocket:
    url: "" # No default (required)
    proxy_url: "" # No default (optional)
    open_message: "" # No default (optional)
    open_message_type: binary
    max_message_size: 33554432
    auto_replay_nacks: true
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []
    connection:
      max_retries: 0 # No default (optional)
    oauth:
      enabled: false
      consumer_key: ""
      consumer_secret: ""
      access_token: ""
      access_token_secret: ""
    basic_auth:
      enabled: false
      username: ""
      password: ""
    jwt:
      enabled: false
      private_key_file: ""
      signing_method: ""
      claims: {}
      headers: {}

Fields

`auto_replay_nacks`

Whether to automatically replay rejected messages (negative acknowledgements, or nacks) at the output level. If the cause of rejections persists, leaving this option enabled can result in back pressure.

Set auto_replay_nacks to false to delete rejected messages. Disabling auto replays can greatly improve memory efficiency of high throughput streams, as the original shape of the data is discarded immediately upon consumption and mutation.

Requires version 4.27.0 or later.

Type: bool

Default: true

`basic_auth`

Configure basic authentication for requests from this component.

Type: object

`basic_auth.enabled`

Whether to use basic authentication in requests.

Type: bool

Default: false

`basic_auth.password`

The password to use for authentication. Used together with username for basic authentication.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`basic_auth.username`

The username of the account credentials to authenticate as. Used together with password for basic authentication.

Type: string

Default: ""

`connection`

Customise how websocket connection attempts are made.

Requires version 4.16.0 or later.

Type: object

`connection.max_retries`

An optional limit to the number of consecutive retry attempts that will be made before abandoning the connection altogether and gracefully terminating the input. When all inputs terminate in this way the service (or stream) will shut down. If set to zero connections will never be reattempted upon a failure. If set below zero this field is ignored (effectively unset).

Type: int

# Examples:
max_retries: -1

# ---

max_retries: 10

`jwt`

Beta

Configure JSON Web Token (JWT) authentication. This feature is in beta and may change in future releases. JWTs provide secure, stateless authentication between services.

Type: object

`jwt.claims`

A map of claims to include in the JWT. Claims pass the identity of the authenticated entity to the service provider.

Type: object

Default: {}

`jwt.enabled`

Whether to use JWT authentication in requests.

Type: bool

Default: false

`jwt.headers`

Additional key-value pairs to include in the JWT header (optional). These headers provide extra metadata for JWT processing.

Type: object

Default: {}

`jwt.private_key_file`

Path to a file containing the PEM-encoded private key using PKCS#1 or PKCS#8 format. The private key must be compatible with the algorithm specified in the signing_method field.

Type: string

Default: ""

`jwt.signing_method`

The cryptographic algorithm used to sign the JWT. Supported algorithms are RS256, RS384, RS512, and EdDSA. This algorithm must be compatible with the private key specified in the private_key_file field.

Type: string

Default: ""

`max_message_size`

A maximum size in bytes for individual messages received from the server. When a message exceeding this limit is received the connection is closed with a 1009 (message too big) status and the input reconnects. A value of 0 disables the limit, which allows the server to make this process allocate an unbounded amount of memory and is therefore not recommended.

Requires version 4.106.0 or later.

Type: int

Default: 33554432

`oauth`

Configure OAuth version 1.0 authentication for secure API access.

Type: object

`oauth.access_token`

The value used to gain access to the protected resources on behalf of the user.

Type: string

Default: ""

`oauth.access_token_secret`

The secret that establishes ownership of the access_token in OAuth 1.0 authentication.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`oauth.consumer_key`

The value used to identify this component or client to the service provider.

Type: string

Default: ""

`oauth.consumer_secret`

The secret that establishes ownership of the consumer key in OAuth 1.0 authentication.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`oauth.enabled`

Whether to enable OAuth version 1.0 authentication for requests.

Type: bool

Default: false

`open_message`

An optional message to send to the server upon connection.

Type: string

`open_message_type`

An optional flag to indicate the data type of open_message.

Requires version 4.12.0 or later.

Type: string

Default: binary

Option Summary

Option	Summary
`binary`	Binary data open_message.
`text`	Text data open_message. The text message payload is interpreted as UTF-8 encoded text data.

binary

Binary data open_message.

text

Text data open_message. The text message payload is interpreted as UTF-8 encoded text data.

`proxy_url`

An optional HTTP proxy URL.

Requires version 4.30.0 or later.

Type: string

`tls`

Configure Transport Layer Security (TLS) settings to secure network connections. This includes options for standard TLS as well as mutual TLS (mTLS) authentication where both client and server authenticate each other using certificates. Key configuration options include enabled to enable TLS, client_certs for mTLS authentication, root_cas/root_cas_file for custom certificate authorities, and skip_cert_verify for development environments.

Type: object

`tls.client_certs[]`

A list of client certificates for mutual TLS (mTLS) authentication. Configure this field to enable mTLS, authenticating the client to the server with these certificates.

You must set tls.enabled: true for the client certificates to take effect.

Certificate pairing rules: For each certificate item, provide either:

Inline PEM data using both cert and key or
File paths using both cert_file and key_file.

Mixing inline and file-based values within the same item is not supported.

Type: array<object>

Default: []

# Examples:
client_certs:
  - cert: foo
    key: bar


# ---

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key

`tls.client_certs[].cert`

The plaintext certificate to use for TLS authentication. Must be paired with the corresponding private key in the key field when using inline PEM data for mTLS client certificates.

Type: string

Default: ""

`tls.client_certs[].cert_file`

The path to a file containing the certificate to use for TLS authentication. Must be paired with the corresponding private key file in the key_file field when using file-based configuration for mTLS client certificates.

Type: string

Default: ""

`tls.client_certs[].key`

Private key for mTLS client certificate as inline PEM data. Must correspond to the client certificate specified in the cert field. Use this field together with cert when providing certificate data inline rather than through files.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

`tls.client_certs[].key_file`

Path to private key file for mTLS client certificate in PEM format. Must correspond to the client certificate specified in the cert_file field. Use this field together with cert_file when loading certificate data from files.

Type: string

Default: ""

`tls.client_certs[].password`

The password to use for the private key (specified in the key or key_file fields), if it is password-protected. The PKCS#1 and PKCS#8 formats are supported. Supports environment variable interpolation for secure password management.

The pbeWithMD5AndDES-CBC algorithm is obsolete and not supported for the PKCS#8 format. This algorithm does not authenticate the ciphertext, making it vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Requires version 4.3.0 or later.

Type: string

Default: ""

# Examples:
password: foo

# ---

password: ${KEY_PASSWORD}

`tls.enable_renegotiation`

Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you’re seeing the error message local error: tls: no renegotiation.

Requires version 3.45.0 or later.

Type: bool

Default: false

`tls.enabled`

Whether to enable TLS for secure connections. Set to true to enable TLS encryption. Required to be true for other TLS options (like client_certs, root_cas, etc.) to take effect.

Type: bool

Default: false

`tls.root_cas`

Specify a root certificate authority to use (optional). This is a string that represents a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for inline certificate data or root_cas_file for file-based certificate loading.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

# Examples:
root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----

`tls.root_cas_file`

Specify the path to a root certificate authority file (optional). This is a file, often with a .pem extension, which contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for file-based certificate loading or root_cas for inline certificate data.

Type: string

Default: ""

# Examples:
root_cas_file: ./root_cas.pem

`tls.skip_cert_verify`

Whether to skip server-side certificate verification. Set to true only for testing environments as this reduces security by disabling certificate validation. When using self-signed certificates or in development, this may be necessary, but should never be used in production. Consider using root_cas or root_cas_file to specify trusted certificates instead of disabling verification entirely.

Type: bool

Default: false

`url`

The URL to connect to.

Type: string

# Examples:
url: ws://localhost:4195/get/ws

Was this helpful?

group Ask in the community

mail Share your feedback

What do you think of this page?

Let us know more:

Let us contact you about your feedback:

websocket

Fields

auto_replay_nacks

basic_auth

basic_auth.enabled

basic_auth.password

basic_auth.username

connection

connection.max_retries

jwt

jwt.claims

jwt.enabled

jwt.headers

jwt.private_key_file

jwt.signing_method

max_message_size

oauth

oauth.access_token

oauth.access_token_secret

oauth.consumer_key

oauth.consumer_secret

oauth.enabled

open_message

open_message_type

proxy_url

tls

tls.client_certs[]

tls.client_certs[].cert

tls.client_certs[].cert_file

tls.client_certs[].key

tls.client_certs[].key_file

tls.client_certs[].password

tls.enable_renegotiation

tls.enabled

tls.root_cas

tls.root_cas_file

tls.skip_cert_verify

url

`auto_replay_nacks`

`basic_auth`

`basic_auth.enabled`

`basic_auth.password`

`basic_auth.username`

`connection`

`connection.max_retries`

`jwt`

`jwt.claims`

`jwt.enabled`

`jwt.headers`

`jwt.private_key_file`

`jwt.signing_method`

`max_message_size`

`oauth`

`oauth.access_token`

`oauth.access_token_secret`

`oauth.consumer_key`

`oauth.consumer_secret`

`oauth.enabled`

`open_message`

`open_message_type`

`proxy_url`

`tls`

`tls.client_certs[]`

`tls.client_certs[].cert`

`tls.client_certs[].cert_file`

`tls.client_certs[].key`

`tls.client_certs[].key_file`

`tls.client_certs[].password`

`tls.enable_renegotiation`

`tls.enabled`

`tls.root_cas`

`tls.root_cas_file`

`tls.skip_cert_verify`

`url`