Skip to main content

Triggers

Triggers perform automated actions (such as sending notifications or executing updates) whenever a new container version is discovered.

Triggers are configured using environment variables following this naming pattern:

WUD_TRIGGER_{trigger_type}_{trigger_name}_{configuration_item}=value
Multiple Instances Supported

You can configure multiple triggers of the same type (for example, multiple SMTP or Discord destinations). Simply assign each one a distinct {trigger_name} identifier (e.g. WUD_TRIGGER_DISCORD_DEV_URL, WUD_TRIGGER_DISCORD_PROD_URL).

📂 Trigger Categories​

WUD supports 17+ triggers organized into three functional categories:

Common Trigger Configuration​

In addition to provider-specific settings, all triggers support the following common configuration variables:

WUD_TRIGGER_{trigger_type}_{trigger_name}_AUTO
Optionalbooleandefault: true

Whether to execute the trigger automatically (false requires manual execution via UI or API)

WUD_TRIGGER_{trigger_type}_{trigger_name}_BATCHTITLE
Optionalstringdefault: ${containers.length} updates available

Template used to render the notification title in batch mode

Allowed values:String template with `${count}` placeholder
WUD_TRIGGER_{trigger_type}_{trigger_name}_INCLUDEBYDEFAULT
Optionalbooleandefault: true

Associate trigger with all containers by default (false makes it opt-in via wud.trigger.include)

WUD_TRIGGER_{trigger_type}_{trigger_name}_MODE
Optionalenumdefault: simple

Execution mode: trigger individually per container or batch all available updates into a single notification

Allowed values:`simple`, `batch`
WUD_TRIGGER_{trigger_type}_{trigger_name}_ONCE
Optionalbooleandefault: true

Execute trigger only once per detected update (prevents duplicate alerts on consecutive runs)

WUD_TRIGGER_{trigger_type}_{trigger_name}_SIMPLEBODY
Optionalstringdefault: Container ${container.name} running with ${container.updateKind.kind} ${container.updateKind.localValue} can be updated to ${container.updateKind.kind} ${container.updateKind.remoteValue}${container.result && container.result.link ? "\\n" + container.result.link : ""}

Template used to render the notification body in simple mode

Allowed values:JS string template with `container` object
WUD_TRIGGER_{trigger_type}_{trigger_name}_SIMPLETITLE
Optionalstringdefault: New ${container.updateKind.kind} found for container ${container.name}

Template used to render the notification title in simple mode

Allowed values:JS string template with `container` object
WUD_TRIGGER_{trigger_type}_{trigger_name}_THRESHOLD
Optionalenumdefault: all

Minimum semver version bump required to fire the trigger

Allowed values:`all`, `major`, `major-only`, `minor`, `minor-only`, `patch`

Threshold Values​

  • all: Executes the trigger for all update types (including digests).
  • major: Executes the trigger for major, minor, or patch semver updates.
  • major-only: Executes the trigger only for major semver updates.
  • minor: Executes the trigger for minor or patch semver updates.
  • minor-only: Executes the trigger only for minor semver updates.
  • patch: Executes the trigger only for patch semver updates.

🚀 Examples​

Customizing Notification Content​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_SMTP_GMAIL_SIMPLETITLE=Container $${container.name} can be updated
      - WUD_TRIGGER_SMTP_GMAIL_SIMPLEBODY=Container $${container.name} can be updated from $${container.updateKind.localValue} to $${container.updateKind.remoteValue}