← All resources

Resource

workflow_trigger

A trigger configuration for automated workflow execution

GraphQL reference →

Configuration

workflowIdWorkflowID!RequiredSet on creation

TypeID (prefix wfl) of the workflow this trigger starts when it fires.

References workflow

set once, at creation

versionIdWorkflowVersionIDOptionalSet on creation

Optional TypeID (prefix wfv) pinning the trigger to one workflow version. Omit to always run the workflow's current version.

References workflow_version

set once, at creation

nameString!Required

Human-readable name for the trigger. Must pass the standard name validation.

configTriggerConfig!Required

Type-tagged configuration determining what makes this trigger fire.

View TriggerConfigInput fields →

isEnabledBoolean!Optional

Whether the trigger starts out armed. Defaults to true when omitted; a disabled trigger is stored but never fires.

concurrencyPolicyConcurrencyPolicy!Optional

How firings are handled while an execution from this trigger is still running. A ConcurrencyPolicy name — ALLOW, QUEUE, SKIP or CANCEL (case-sensitive); defaults to ALLOW when omitted. folderWatch triggers must use ALLOW.

Allowed values

ALLOW — Allow multiple concurrent executions

QUEUE — Queue new executions if one is running

SKIP — Skip new executions if one is running

CANCEL — Cancel running execution and start new one

maxConcurrentExecutionsIntOptional

Cap on simultaneously running executions from this trigger. Must be at least 1. Omit for unlimited; folderWatch triggers must leave it unset.

Input types

Fields for the structured values used in this resource’s configuration.

TriggerConfigInput

Trigger configuration: a GraphQL oneOf input, so set exactly one member and omit the rest — the member you set is what selects the kind of trigger. There is no discriminator field to set alongside it. Stands in for the not-yet-modelled TriggerConfig GraphQL union.

Set exactly one field to a non-null value.

scheduledScheduledTriggerConfigInputOptional

CRON schedule configuration. Set this member and no other.

View ScheduledTriggerConfigInput fields →

eventEventTriggerConfigInputOptional

Platform-event configuration. Set this member and no other.

View EventTriggerConfigInput fields →

deviceMqttDeviceMQTTTriggerConfigInputOptional

Device MQTT configuration. Set this member and no other.

View DeviceMQTTTriggerConfigInput fields →

webhookWebhookTriggerConfigInputOptional

Webhook configuration. Set this member and no other.

View WebhookTriggerConfigInput fields →

edgeAppEventEdgeAppEventTriggerConfigInputOptional

Edge app event configuration. Set this member and no other.

View EdgeAppEventTriggerConfigInput fields →

folderWatchFolderWatchTriggerConfigInputOptional

Folder-watch configuration. Set this member and no other.

View FolderWatchTriggerConfigInput fields →

ScheduledTriggerConfigInput

Scheduled (CRON) trigger configuration. Set as TriggerConfigInput's single member to make this kind of trigger.

cronExpressionString!Required

CRON expression driving the schedule. Must be non-empty and have 5 or 6 whitespace-separated fields (minute hour day month weekday [year]).

timezoneStringOptional

IANA timezone name the CRON expression is evaluated in (e.g. "Europe/Berlin"). Omit to evaluate in the scheduler's default timezone.

overlapPolicyOverlapPolicy!Required

What to do when the schedule fires while a previous execution is still running. Must be an OverlapPolicy name — ALLOW, SKIP or CANCEL (case-sensitive); any other value is rejected as a validation error.

Allowed values

ALLOW — Allow overlapping CRON executions

SKIP — Skip if previous execution still running

CANCEL — Cancel previous and start new

EventTriggerConfigInput

Event-based trigger configuration. Set as TriggerConfigInput's single member to make this kind of trigger.

topicString!Required

Platform event topic to subscribe to. Must be non-empty.

filterStringOptional

Optional JSONLogic expression evaluated against the event payload; the workflow only starts when it evaluates truthy. Omit to fire on every event on the topic.

dataQueryStringOptional

Optional GraphQL query executed when the event fires. The event's resource ID is bound to the $id variable and the result is merged into the workflow input under the 'data' key. Validated against the live schema on save; an unparseable query is rejected.

DeviceMQTTTriggerConfigInput

Device MQTT trigger configuration. Set as TriggerConfigInput's single member to make this kind of trigger.

topicString!Required

Device-relative MQTT topic filter (MQTT + and # wildcards allowed). Must be non-empty and must NOT include the tenant/device prefix — a value starting with "t/" is rejected.

deviceIdStringOptional

Optional device TypeID (prefix dev) narrowing the trigger to one device. Omit (or pass empty) to match every device in the tenant.

filterStringOptional

Optional JSONLogic expression evaluated against the MQTT trigger envelope; the workflow only starts when it evaluates truthy.

WebhookTriggerConfigInput

Webhook trigger configuration. Set as TriggerConfigInput's single member to make this kind of trigger.

pathString!Required

URL path the webhook is exposed on. Must be non-empty and start with "/".

methodString!Required

HTTP method the webhook accepts. Must be one of GET, POST, PUT, PATCH or DELETE (compared case-insensitively).

authRequiredBoolean!Required

Whether callers must authenticate. When false the webhook endpoint is reachable without credentials.

EdgeAppEventTriggerConfigInput

edgeApp.event trigger configuration — fires when an edge app replays a bridge.publish event through its outbox. Every supplied scope must match for the trigger to fire. Set as TriggerConfigInput's single member to make this kind of trigger.

controllerIdStringOptional

Optional controller TypeID (prefix ctl) to scope on; the event's controller must match exactly. Omit (or pass empty) to match any controller in the tenant.

edgeAppHandleStringOptional

Optional edge app wire handle to scope on; matched exactly against the emitting edge app. Omit (or pass empty) to match any edge app.

topicStringOptional

Optional bridge.publish topic to scope on; matched exactly (no wildcards). Omit (or pass empty) to match any topic.

FolderWatchTriggerConfigInput

Folder-watch trigger configuration. Set as TriggerConfigInput's single member to make this kind of trigger.

folderIdFolderID!Required

TypeID (prefix fld) of the folder to watch. Must parse as a folder ID.

prefixString!Required

Folder-relative prefix watched for new files. The watch is shallow — files in subdirectories below the prefix are never picked up. Must not contain '..' segments.

Read-only values

Show values
idWorkflowTriggerID!Read only

Unique identifier

computed by the platform

tenantIdTenantID!Read only

Tenant ID

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.