Redis List RealtimeTrigger

Redis List RealtimeTrigger
Certified
Realtime trigger from a Redis list

Continuously polls LPOP one element at a time (every ~100 ms) and starts one Execution per item. Use Trigger for batched polling.

yaml
type: io.kestra.plugin.redis.list.RealtimeTrigger

Examples

Consume an element from the head of a list in real-time.

yaml
id: list_listen
namespace: company.team

tasks:
  - id: echo
    type: io.kestra.plugin.core.log.Log
    message: "Received '{{ trigger.value }}'"

triggers:
  - id: watch
    type: io.kestra.plugin.redis.list.RealtimeTrigger
    url: redis://localhost:6379/0
    key: mytriggerkey

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-redis --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

key *string

Redis list key

Rendered key passed to LPOP.

serdeType *string

DefaultSTRING

Possible Values

STRINGJSON

Format of the data contained in Redis

Defaults to STRING. Controls how list elements are decoded. With JSON, an element that is not valid JSON is kept as a string and a warning is logged.

url *string

Redis connection string

allowConcurrent boolean

Defaultfalse

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

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

value object

The value