Skip to main content

Triggers

Artifact triggers provide event-driven execution of Workflow Runs in response to changes to File Artifacts. An artifact trigger runs a selected Workflow Instance with the provided workflow configuration.

Configuration​

An artifact trigger defines a source, a Workflow Instance, and workflow configuration. The source is either one specific File Artifact or one Folder.

  • Specific file: The artifact trigger runs whenever that File Artifact is modified.
  • Folder: The artifact trigger runs whenever a matching file is created, modified, or deleted within that Folder or any of its subfolders. A Folder trigger requires a file-name pattern using fnmatch syntax, matched against each file's name rather than its path.

The source and the Workflow Instance must belong to the same Project.

Optionally, set a debounce period to limit the number of Workflow Runs started by rapid changes. The first matching change starts a run, while additional matching changes during the debounce period are ignored.

Artifact triggers can be enabled or disabled without deleting their configuration. Disabled artifact triggers do not respond to File Artifact changes.

Create an artifact trigger with the Create Artifact Trigger endpoint.

Execution Behavior​

Changes made by users or authorized workflows from other Projects can activate an artifact trigger. Changes made by workflows in the same Project are ignored, preventing recursive runs when a triggered workflow modifies watched Artifacts.

Manage Triggers​

The List Artifact Triggers and Get Artifact Trigger endpoints show artifact triggers and their status.

The List Artifact Trigger Events endpoint shows trigger event history and associated Workflow Runs. The Play Artifact Trigger endpoint starts a Workflow Run immediately, allowing you to test the configured Workflow Instance and workflow configuration without waiting for a matching event. Artifact triggers can also be updated or deleted.