Skip to content

Create a trigger

Choose a trigger kind based on when it should run. Each kind page documents the corresponding new_trigger() example and its specification.

Choose a trigger kind

  • Scheduler - Run a task on a cron schedule - scheduler

  • Lifecycle - Run a task when an entity reaches selected states - lifecycle

Create from a function or workflow

Functions and workflows also provide a trigger() method for creating triggers in their execution context.

Function.trigger()
function = project.get_function("my-function")

trigger = function.trigger(
    action="job",
    kind="scheduler",
    name="daily-function-run",
    schedule="0 0 * * * ?",
)

trigger = function.trigger(
    action="job",
    kind="lifecycle",
    name="validate-on-upload",
    key="store://project/artifact/*",
    states=["READY"],
    template={"inputs": {"my-param": "{{input.key}}"}},
)
Workflow.trigger()
workflow = project.get_workflow("my-workflow")

trigger = workflow.trigger(
    action="pipeline",
    kind="scheduler",
    name="weekly-workflow-run",
    schedule="0 0 * * 0 ?",
)

trigger = workflow.trigger(
    action="pipeline",
    kind="lifecycle",
    name="validation-pipeline-on-upload",
    key="store://project/artifact/*",
    states=["READY"],
    template={"parameters": {"param-name": "{{input.key}}"}},
)