rebase workflow trigger

Manage workflow event triggers.

Synopsis

rebase workflow trigger show <name> --project <project>
rebase workflow trigger set <name> --project <project> --on-workflow <project/workflow> [--on success|failure|completion]
rebase workflow trigger set <name> --project <project> --on-update <dataset> [--on-update <dataset> ...] \
    [--require all|any] [--at-most-every 15m] [--deadline-cron "0 9 * * *"] [--deadline-timezone <tz>]
rebase workflow trigger pause <name> --project <project>
rebase workflow trigger resume <name> --project <project>
rebase workflow trigger clear <name> --project <project>
rebase workflow trigger list [--project <project>]

Name-based lookup requires --project; every subcommand also accepts --id <uuid> instead of a name.

Subcommands

SubcommandDescription
showShow the trigger config, per-source state (pending updates, watermarks), last fired time, and next deadline.
setSet or replace the workflow's trigger (--on-workflow or --on-update, not both).
pauseStop the trigger from firing while keeping its state.
resumeRe-activate a paused trigger.
clearRemove the trigger.
listList all workflows that have triggers.

Options for set

OptionTypeDescription
--on-workflowstrFire when this workflow's runs finish. project/workflow, or a bare name for the same project.
--onstrWith --on-workflow: success (default), failure, or completion.
--on-updatestrFire when this dataset updates. Repeat for multiple datasets. Datasets are created if missing.
--requirestrWith --on-update: all (default) waits for every dataset; any fires on each update.
--at-most-everystrRate limit, e.g. 15m, 1h, 900s. Rapid updates within the window coalesce into one run.
--deadline-cronstrFive-field cron deadline: guarantee one run per deadline period even if require is unmet.
--deadline-timezonestrIANA timezone for the deadline cron.

Behavior

Trigger changes create (or reuse) a workflow version, so pause followed by resume returns to the original version. Pausing keeps the trigger and its accumulated state registered; disabling the workflow (enabled=false) stops evaluation entirely.

Runs fired by a trigger carry trigger_source: "trigger" and, when the entrypoint declares a ctx parameter, receive a TriggerContext with the firing reason, per-dataset watermarks (since/latest), and any datasets missing at a deadline firing.

See Triggers and Datasets for the full model and rebase dataset for managing datasets.

On this page