Shell ScriptTrigger
CertifiedTrigger on shell script condition
Shell ScriptTrigger
Trigger on shell script condition
Polls by running an inline shell script in a container (default image ubuntu) and emits when exitCondition matches. Supports edge mode to emit only on transitions and polls every 60s by default. Accepts 'exit N' or a regex (fallback substring) matched against emitted vars and failure logs; run untrusted scripts only in trusted images.
type: io.kestra.plugin.scripts.shell.ScriptTriggerExamples
Trigger when the script fails with an implicit error (exit 1).
id: script_trigger
namespace: company.team
triggers:
- id: script_failure
type: io.kestra.plugin.scripts.shell.ScriptTrigger
interval: PT10S
exitCondition: "exit 1"
edge: true
containerImage: ubuntu
script: |
# This command fails because the file doesn't exist, resulting in a non-zero exit code.
cat /path/that/does/not/exist
tasks:
- id: log
type: io.kestra.plugin.core.log.Log
message: "Triggered with exitCode={{ trigger.exitCode }} (condition={{ trigger.condition }})"
Properties
exitCondition *string
Condition to match
Rendered condition evaluated after each execution; the trigger emits only when it matches. 'exit N' compares the exit code, otherwise the string is used as a regex (or substring fallback) against emitted vars (from ::{"outputs": ...}::) and failure logs.
script *string
Inline shell script
Multi-line script executed on each poll, with the same semantics as the Shell Script task.
allowConcurrent boolean
falseSpecifies whether a trigger is allowed to start a new execution even if a previous run is still in progress.
containerImage string
ubuntuContainer image for script execution
Image used by the Script task to run the inline shell script; defaults to 'ubuntu'. Provide an image that includes the needed shell and tooling.
edge booleanstring
trueEdge trigger mode
When true (default), emit only on a transition from not matching to matching. When false, emit on every poll that matches.
interval string
PT1MdurationCheck interval
Interval between polls; default PT60S. The scheduler uses this to schedule the next evaluation.
stopAfter array
CREATEDSUBMITTEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPEDBREAKPOINTRESUBMITTEDList of execution states after which a trigger should be stopped (a.k.a. disabled).
when string
trueA 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
condition string
Rendered condition
Rendered value of the exitCondition property for this poll.
exitCode integer
Script exit code
Exit code returned by the shell process (may be null if not available).
timestamp string
date-timeTimestamp of the event that fired the trigger
vars object
Script vars
Vars produced by the task (e.g. via ::{"outputs": {...}}:: convention). This is the main structured way to evaluate non-exit conditions on successful runs.
