TCP RealtimeTrigger

TCP RealtimeTrigger
Certified
Trigger on incoming TCP messages

Listens on a TCP port and fires immediately when data is received. Default bind host 0.0.0.0, UTF-8 decoding. Stops when trigger is canceled or kill/stop is called.

yaml
type: io.kestra.plugin.fs.tcp.RealtimeTrigger

Examples

Trigger a flow whenever a TCP message is received.

yaml
id: tcp_realtime
namespace: dev

triggers:
  - id: tcp_listener
    type: io.kestra.plugin.fs.tcp.RealtimeTrigger
    host: 0.0.0.0
    port: 9090

tasks:
  - id: log_message
    type: io.kestra.plugin.core.log.Log
    message: "Received {{ trigger.payload }} from {{ trigger.sourceIp }}"

Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:

kestractl plugins get io.kestra.plugin:plugin-fs --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

port *integerstring

TCP port to listen on

allowConcurrent boolean

Defaultfalse

Specifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.

encoding string

DefaultUTF-8

Encoding for incoming data

host string

Default0.0.0.0

Interface to bind

stopAfter array

SubTypestring

Possible Values

CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

when string

Defaulttrue

A condition that determines whether the trigger should run.

A Pebble expression evaluated at trigger time. The trigger fires only when the expression evaluates to a truthy value (true, a non-empty string, a non-zero number). Use this to gate trigger execution on dynamic runtime values such as execution labels, flow variables, or environment conditions.

Outputs

payload string

The received TCP payload

sourceIp string

The IP address of the sender

sourcePort integer

The port of the sender

timestamp string

Formatdate-time

The timestamp when the message was received