WebSocket

WebSocket (web-socket)

Consume events from remote WebSocket endpoints.

Messaging json

Minimal example

input:
  web-socket:
    url: ""

JSON

{
  "input": {
    "web-socket": {
      "url": ""
    }
  }
}

Contents

• Minimal example

• Fields

• Trigger

• Reliability

• Batching

• Connection

• Headers

• Framing

• Authentication

• Security

• Health

• Cursors

• Server Input

• Schema

Fields

Field	Type	Required	Description
url Connection	url (string)	✅	Target WebSocket endpoint (supports templating). Examples: https://example.com/path
trigger Trigger	Trigger		Optional schedule for reconnect attempts; if omitted runs once and relies on reconnect policy.
retry Reliability	Retry		Retry configuration applied to user-level failures (message processing, decode).
batch Batching	Batch		Logical batching behaviour shared with other inputs.
mode Connection	Mode		Operating mode for the connection (currently client only). Allowed values: client, server-output, server-input, relay
headers Headers	map (string)		Headers applied to the opening handshake (templated).
query Headers	map (string)		Query parameters appended to the connection URL.
subprotocols Headers	string[]		Preferred subprotocols listed in order of precedence.
extract-headers Headers	string[]		Response headers to surface in event metadata (case-insensitive).
permessage-deflate Framing	boolean (bool)		Request the permessage-deflate extension during the handshake.
payload Framing	Payload		Interpretation applied to inbound frames. Allowed values: text, json, binary, binary-base64
auth Authentication	Auth		Authentication material injected during the handshake.
tls Security	Tls		TLS configuration for client connections.
heartbeat Health	Heartbeat		Optional heartbeat configuration (ping/pong).
reconnect Reliability	Reconnect		Reconnection policy applied when the socket closes unexpectedly.
cursor Cursors	Cursor		Cursor persistence and replay configuration.
server Server Input	Server		Embedded server configuration when operating in server-input mode.

Trigger

Show fields

Field	Type	Required	Description
trigger	Trigger		Optional schedule for reconnect attempts; if omitted runs once and relies on reconnect policy.

Reliability

Show fields

Field	Type	Required	Description
retry	Retry		Retry configuration applied to user-level failures (message processing, decode).
reconnect	Reconnect		Reconnection policy applied when the socket closes unexpectedly.

Batching

Show fields

Field	Type	Required	Description
batch	Batch		Logical batching behaviour shared with other inputs.

Connection

Show fields

Field	Type	Required	Description
url	url (string)	✅	Target WebSocket endpoint (supports templating). Examples: https://example.com/path
mode	Mode		Operating mode for the connection (currently client only). Allowed values: client, server-output, server-input, relay

Headers

Show fields

Field	Type	Required	Description
headers	map (string)		Headers applied to the opening handshake (templated).
query	map (string)		Query parameters appended to the connection URL.
subprotocols	string[]		Preferred subprotocols listed in order of precedence.
extract-headers	string[]		Response headers to surface in event metadata (case-insensitive).

Framing

Show fields

Field	Type	Required	Description
permessage-deflate	boolean (bool)		Request the permessage-deflate extension during the handshake.
payload	Payload		Interpretation applied to inbound frames. Allowed values: text, json, binary, binary-base64

Authentication

Show fields

Field	Type	Required	Description
auth	Auth		Authentication material injected during the handshake.

Security

Show fields

Field	Type	Required	Description
tls	Tls		TLS configuration for client connections.

Health

Show fields

Field	Type	Required	Description
heartbeat	Heartbeat		Optional heartbeat configuration (ping/pong).

Cursors

Show fields

Field	Type	Required	Description
cursor	Cursor		Cursor persistence and replay configuration.

Server Input

Show fields

Field	Type	Required	Description
server	Server		Embedded server configuration when operating in server-input mode.

Schema

• Trigger - Cron - Window - Start Options
• Trigger - Interval - Window - Start Options
• Trigger Options
• Trigger - Message Fields
• Trigger - Cron - Window - Start - Start Time Fields
• Trigger - Cron - Window Fields
• Trigger - Cron Fields
• Trigger - Interval - Window - Start - Start Time Fields
• Trigger - Interval - Window Fields
• Trigger - Interval Fields
• Retry Fields
• Batch Fields
• Auth - Basic Fields
• Auth Fields
• Tls Fields
• Heartbeat Fields
• Reconnect Fields
• Cursor Fields
• Server - Tls Fields
• Server Fields
• Headers Table
• Query Table
• Auth - Headers Table
• Auth - Query Table
• Trigger - Message - Filter Kind Options
• Trigger - Message - Filter Source Options
• Trigger - Message - Filter Type Options
• Mode Options
• Payload Options
• Heartbeat - Action Options

Trigger - Cron - Window - Start Options

Option	Name	Type	Description
start-time	Start Time	object
tracked	Tracked	string	Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Interval - Window - Start Options

Option	Name	Type	Description
start-time	Start Time	object
tracked	Tracked	string	Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger Options

Option	Name	Type	Description
message	Message	object
cron	Cron	object
interval	Interval	object

Trigger - Message Fields

Field	Type	Required	Description
limit	number (integer)		The number of times to run the input. Examples: 42, 1.2e-10
filter-kind	Filter Kind		Specifies whether the message originated from the “system” or by the “user”. Allowed values: system, user, runtime-artifact-fetch, runtime-artifact-fetch-error, runtime-artifact-clear, runtime-artifact-clear-ack, runtime-artifact-fetch-reply, runtime-artifact-update, …
filter-source	Filter Source[]		Specifies what process generated the message. Was it a “server”, “worker” or “job”? Allowed values: job, worker, server
filter-worker	string		Specifies what worker to select.
filter-job	string		Specifies the name of the job that the message came from.
filter-type	Filter Type[]		Specifies that particular types of message ought to match. Allowed values: worker-licensed, worker-unlicensed, variable, variable-deleted, begin-shutting-down-job, begin-shutting-down-server, begin-shutting-down-worker, broadcast-job-thread-state, …
filter-tag	string		Specifies that messages matched ought to carry a tag with a particular value. This only matches against user-generated messages.

Trigger - Cron - Window - Start - Start Time Fields

Field	Type	Required	Description
start-time	time-format (string)	✅	Allows the windowing to start at a specified time. Hint: %Y-%m-%d %H:%M:%S%.3f %z
highwatermark-file	path (string)	✅	Specify file where timestamp would be stored in order to resume, for when Job has been restarted. Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Cron - Window Fields

Field	Type	Required	Description
size	duration (string)	✅	Window size.
offset	duration (string)		Window offset.
start	Start		Specify file where timestamp would be stored in order to resume, for when Job has been restarted.

Trigger - Cron Fields

Field	Type	Required	Description
cron	cron-expression (string)	✅	The Cron pattern.
immediate	boolean (bool)		Run as soon as invoked, instead of waiting for the specified cron interval.
random-offset	duration (string)		Sets a random offset to the schedule, then sticks to it.
window	Window		Optional window definition when the schedule should only read a bounded range.

Trigger - Interval - Window - Start - Start Time Fields

Field	Type	Required	Description
start-time	time-format (string)	✅	Allows the windowing to start at a specified time. Hint: %Y-%m-%d %H:%M:%S%.3f %z
highwatermark-file	path (string)	✅	Specify file where timestamp would be stored in order to resume, for when Job has been restarted. Examples: /path/to/file, c:\users\joe\data\file.txt

Trigger - Interval - Window Fields

Field	Type	Required	Description
size	duration (string)	✅	Window size.
offset	duration (string)		Window offset.
start	Start		Specify file where timestamp would be stored in order to resume, for when Job has been restarted.

Trigger - Interval Fields

Field	Type	Required	Description
duration	duration (string)	✅	Duration to wait between events.
random-offset	duration (string)		Sets a random offset to the schedule, then sticks to it.
window	Window		Optional window definition when the interval should only cover a bounded range.

Retry Fields

Field	Type	Required	Description
timeout	time-interval (string)	✅	timeout (e.g. 500ms, 2s etc. - default is 30). Examples: 500ms, 2h
retries	number (integer)		number of retries. Examples: 42, 1.2e-10

Batch Fields

Field	Type	Required	Description
uuid-field	field (string)		Field where generated uuid, the unique marker for the group, will be stored. Examples: data_field
invocation-time-field	field (string)		Field where invocation time will be stored. Examples: data_field
completion-time-field	field (string)		Field where completion (end of execution) time will be stored. Examples: data_field
begin-marker-field	field (string)		Field used to mark first event in the group. Examples: data_field
end-marker-field	field (string)		Field used to mark last event in the group. Examples: data_field
line-count-field	field (string)		Field used to store the line count of the batch. Examples: data_field
line-num-field	field (string)		Field used to store the line number of the batch. Examples: data_field

Auth - Basic Fields

Field	Type	Required	Description
username	string	✅	Username credential (supports templating).
password	string	✅	Password credential (supports templating).

Auth Fields

Field	Type	Required	Description
headers	map (string)		Static or templated headers added during the handshake.
query	map (string)		Query parameters added to the connection URL.
bearer-token	string		Bearer token inserted as Authorization: Bearer ....
basic	Basic		Basic auth credentials sent via header.

Tls Fields

Field	Type	Required	Description
ca-certificate	string		Custom CA certificate to trust.
client-certificate	string		Client certificate for mutual TLS.
client-key	string		Client private key for mutual TLS.
insecure-skip-verify	boolean (bool)		Skip certificate validation (unsafe).

Heartbeat Fields

Field	Type	Required	Description
ping-interval	string		Interval between ping frames.
timeout	string		Grace period for receiving a pong before the connection is considered unhealthy.
action	Action		What to do when a heartbeat misses the timeout. Allowed values: reconnect, log-only
payload	string		Optional ping payload to send with heartbeats.

Reconnect Fields

Field	Type	Required	Description
initial-backoff	string		Backoff applied after the first failure (human-friendly duration).
max-backoff	string		Maximum backoff duration before clamping (human-friendly duration).
multiplier	number (integer)		Exponential multiplier applied after each failure. Examples: 42, 1.2e-10
jitter	number (integer)		Random jitter factor applied to backoff windows (0.0-1.0). Examples: 42, 1.2e-10
max-attempts	number (integer)		Maximum number of consecutive attempts before giving up (None=infinite). Examples: 42, 1.2e-10
reset-after	string		Time after a successful connection before resetting the attempt counter.

Cursor Fields

Field	Type	Required	Description
header-name	string		Header name used to propagate the cursor on reconnect (e.g. Last-Event-ID).
query-parameter	string		Query parameter name used to propagate the cursor value.
persist-to	string		Storage location for cursor state (defaults to job-scoped state).
initial-value	string		Initial cursor value to send on the first connection.
state-id	string		Optional explicit state identifier when sharing cursors across jobs.
resume-on-reconnect	boolean (bool)		Whether to inject the cursor on every reconnect attempt.
value-field	field (string)		Event field used to derive the cursor value after successful delivery. Examples: data_field
value-pointer	json-pointer (string)		JSON pointer used to derive the cursor value from emitted payloads.

Server - Tls Fields

Field	Type	Required	Description
cert	path (string)	✅	Path to the certificate file. Examples: /path/to/file, c:\users\joe\data\file.txt
key	path (string)	✅	Path to the private key file. Examples: /path/to/file, c:\users\joe\data\file.txt

Server Fields

Field	Type	Required	Description
bind	string	✅	Address to bind (e.g. 0.0.0.0:8080).
path	string		Optional path/route restriction.
tls	Tls		Optional TLS material for the listener.
max-connections	number (integer)		Maximum simultaneously connected clients (None = unlimited). Examples: 42, 1.2e-10
idle-timeout	string		Disconnect clients after this idle duration.
allowed-origins	string[]		Restrict accepted requests to these Origin / Sec-WebSocket-Origin values.
send-buffer-capacity	number (integer)		Per-connection send buffer (messages queued when clients are slow). Examples: 42, 1.2e-10

Headers Table

Header	Value
Header-Name	value

Value format: templated-text.

Query Table

Parameter	Value
param	value

Value format: templated-text.

Auth - Headers Table

Header	Value
Header-Name	value

Value format: templated-text.

Auth - Query Table

Parameter	Value
param	value

Value format: templated-text.

Trigger - Message - Filter Kind Options

Value	Description
system	System
user	User
runtime-artifact-fetch	Runtime Artifact Fetch
runtime-artifact-fetch-error	Runtime Artifact Fetch Error
runtime-artifact-clear	Runtime Artifact Clear
runtime-artifact-clear-ack	Runtime Artifact Clear Ack
runtime-artifact-fetch-reply	Runtime Artifact Fetch Reply
runtime-artifact-update	Runtime Artifact Update
runtime-artifact-update-ack	Runtime Artifact Update Ack

Trigger - Message - Filter Source Options

Value	Description
job	Job
worker	Worker
server	Server

Trigger - Message - Filter Type Options

Value	Description
worker-licensed	Worker Licensed
worker-unlicensed	Worker Unlicensed
variable	Variable
variable-deleted	Variable Deleted
begin-shutting-down-job	Begin Shutting Down Job
begin-shutting-down-server	Begin Shutting Down Server
begin-shutting-down-worker	Begin Shutting Down Worker
broadcast-job-thread-state	Broadcast Job Thread State
broadcast-server-thread-state	Broadcast Server Thread State
broadcast-worker-thread-state	Broadcast Worker Thread State
check-job-report-time	Check Job Report Time
check-worker-report-time	Check Worker Report Time
de-register-job-thread-dependency	De Register Job Thread Dependency
de-register-server-thread-dependency	De Register Server Thread Dependency
de-register-worker-thread-dependency	De Register Worker Thread Dependency
deployed-job-active	Deployed Job Active
deployed-job-removed	Deployed Job Removed
deployed-job-should-be-running	Deployed Job Should Be Running
deployment-phase	Deployment Phase
heart-beat	Heart Beat
initialise-internal-state	Initialise Internal State
initialise-job-states	Initialise Job States
job-batch-end	Job Batch End
job-backlog-update	Job Backlog Update
job-checkpoint-update	Job Checkpoint Update
job-deploy-ready	Job Deploy Ready
job-deployed	Job Deployed
job-document-end	Job Document End
job-document-start	Job Document Start
job-errors	Job Errors
job-execution-anomaly	Job Execution Anomaly
job-execution-status	Job Execution Status
job-emit-custom	Job Emit Custom
job-finished	Job Finished
job-idle	Job Idle
job-initiated	Job Initiated
job-is-processing	Job Is Processing
job-logs	Job Logs
job-metrics	Job Metrics
job-notifications	Job Notifications
job-removing	Job Removing
job-removed	Job Removed
job-remove-failed	Job Remove Failed
job-remove-ready	Job Remove Ready
job-replaced	Job Replaced
job-required	Job Required
job-run-ended	Job Run Ended
job-runtime-error	Job Runtime Error
job-runtime-settings	Job Runtime Settings
job-run-started	Job Run Started
job-running-docker	Job Running Docker
job-running-script	Job Running Script
job-running-subprocess	Job Running Subprocess
job-running-system-d	Job Running System D
job-settings	Job Settings
job-step-statistics	Job Step Statistics
job-started	Job Started
job-staged	Job Staged
job-state-transition	Job State Transition
job-shutting-down	Job Shutting Down
job-stopping	Job Stopping
job-stopped	Job Stopped
job-timed-out	Job Timed Out
job-suspicious-silence	Job Suspicious Silence
job-thread-state	Job Thread State
job-trace	Job Trace
job-trace-requires-samples	Job Trace Requires Samples
job-updated	Job Updated
job-worker-comms-error	Job Worker Comms Error
job-unstaged	Job Unstaged
license-state-changed	License State Changed
license-validation-failed	License Validation Failed
license-validation-ok	License Validation Ok
license-volume-violation	License Volume Violation
new-license	New License
override-job-coordinated-shutdown	Override Job Coordinated Shutdown
override-server-coordinated-shutdown	Override Server Coordinated Shutdown
override-worker-coordinated-shutdown	Override Worker Coordinated Shutdown
register-job-thread-dependency	Register Job Thread Dependency
register-server-thread-dependency	Register Server Thread Dependency
register-worker-thread-dependency	Register Worker Thread Dependency
run-job-failure	Run Job Failure
server-logs	Server Logs
server-metrics-batch	Server Metrics Batch
server-started	Server Started
server-starting	Server Starting
server-stopping	Server Stopping
server-thread-state	Server Thread State
server-worker-comms-error	Server Worker Comms Error
shutdown-jobs	Shutdown Jobs
shutdown-worker	Shutdown Worker
system-shutdown	System Shutdown
update-upstream-sync-for-job	Update Upstream Sync For Job
update-upstream-sync-for-worker	Update Upstream Sync For Worker
update-variable	Update Variable
user-alert	User Alert
user-generated	User Generated
user-notification	User Notification
worker-command-for-job	Worker Command For Job
worker-auth-lease-ack	Worker Auth Lease Ack
worker-connected	Worker Connected
worker-created	Worker Created
worker-debug-heart-beat	Worker Debug Heart Beat
worker-error	Worker Error
worker-first-seen	Worker First Seen
worker-heart-beat	Worker Heart Beat
worker-logs	Worker Logs
worker-metrics-batch	Worker Metrics Batch
worker-offline	Worker Offline
worker-requests-auth-lease	Worker Requests Auth Lease
worker-server-comms-error	Worker Server Comms Error
worker-settings	Worker Settings
worker-shutdown	Worker Shutdown
worker-shutting-down	Worker Shutting Down
worker-started	Worker Started
worker-state-uuid	Worker State Uuid
worker-stopping	Worker Stopping
worker-suspicious-silence	Worker Suspicious Silence
worker-system-information	Worker System Information
worker-thread-state	Worker Thread State
worker-updated	Worker Updated
worker-modified	Worker Modified
worker-removed	Worker Removed
context-changed	Context Changed
rerender-deployment	Rerender Deployment
job-killed	Job Killed
message-serviced	Message Serviced
failed-to-service-message	Failed To Service Message
worker-wants-initial-settings	Worker Wants Initial Settings
worker-wants-initial-settings-reply	Worker Wants Initial Settings Reply
worker-wants-deployed-jobs	Worker Wants Deployed Jobs
worker-wants-deployed-jobs-reply	Worker Wants Deployed Jobs Reply
worker-wants-job-configuration	Worker Wants Job Configuration
worker-wants-job-configuration-reply	Worker Wants Job Configuration Reply
job-wants-dslir-key	Job Wants Dslir Key
job-wants-dslir-key-reply	Job Wants Dslir Key Reply
worker-wants-dslir-key	Worker Wants Dslir Key
worker-wants-dslir-key-reply	Worker Wants Dslir Key Reply
job-wants-variables	Job Wants Variables
job-wants-variables-reply	Job Wants Variables Reply
job-wants-credentials	Job Wants Credentials
job-wants-credentials-reply	Job Wants Credentials Reply
job-wants-credentials-error	Job Wants Credentials Error
job-wants-secret-variables-reply	Job Wants Secret Variables Reply
job-credentials-invalidated	Job Credentials Invalidated
aggregator-health	Aggregator Health
worker-verification-token	Worker Verification Token
worker-requests-verification-token	Worker Requests Verification Token
runtime-artifact-update	Runtime Artifact Update
runtime-artifact-update-ack	Runtime Artifact Update Ack
runtime-artifact-clear	Runtime Artifact Clear
runtime-artifact-clear-ack	Runtime Artifact Clear Ack
runtime-artifact-fetch	Runtime Artifact Fetch
runtime-artifact-fetch-reply	Runtime Artifact Fetch Reply
runtime-artifact-fetch-error	Runtime Artifact Fetch Error

Mode Options

Value	Description
client	Client
server-output	Server Output
server-input	Server Input
relay	Relay

Payload Options

Value	Description
text	Text
json	Json
binary	Binary
binary-base64	Binary Base64

Heartbeat - Action Options

Value	Description
reconnect	Reconnect
log-only	Log Only