Skip to main content

Trigger

Category: Trigger
Node id: trigger

Handles event-based triggers: manual, webhook, schedule, condition, and event matching

What it does​

  • Manual trigger activation with user attribution
  • Webhook trigger with optional signature validation
  • Schedule-based trigger with timezone-aware evaluation
  • Condition-based trigger with AND/OR logic operators
  • Event matching trigger by type and source
  • Comparison operators: eq, ne, gt, lt, gte, lte, contains, matches
  • Automatic next-run calculation for schedule triggers

Use cases​

  • Start a pipeline manually from the UI or API
  • React to incoming webhook events from external services
  • Run pipelines on a recurring schedule (every minute/hour/day/week)
  • Trigger downstream processing only when specific conditions are met
  • Match and route incoming events by type and source

Runtime​

  • Performance tier: fast

Input ports​

NameTypeRequiredDescription
payloadjsonNoEvent payload data. In production, injected by the trigger system. For testing, provide via fixture or override.
metadatajsonNoAdditional metadata for the event
signaturetextNoWebhook signature for validation (webhook type)
event_typetextNoEvent type string for event-based triggers (e.g. 'patient.created')
event_sourcetextNoEvent source identifier for event-based triggers

Output ports​

NameTypeRequiredDescription
resultjsonNoFull trigger result with event, reason, and metadata
triggeredbooleanNoWhether the trigger condition was met
successbooleanNoWhether the trigger processing completed

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Trigger TypetypeenumNomanualmanual, webhook, schedule, condition, eventType of trigger mechanism
SourcesourcestringNoSource identifier for the trigger
Triggered Bytriggered_bystringNomanualIdentifier for who triggered (manual type)
Webhook URLwebhook_urlstringNoURL for webhook trigger
ScheduleschedulestringNoSchedule expression (e.g. 'every hour')
ConditionsconditionsarrayNoArray of conditions for condition trigger
Event Typeevent_typestringNoExpected event type to match (event type)

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
HTTP MethodmethodstringNoPOSTHTTP method for webhook
Validate Signaturevalidate_signaturebooleanNofalseWhether to validate webhook signatures
TimezonetimezonestringNoUTCTimezone for schedule evaluation
LogiclogicenumNoandand, orHow to combine conditions (condition type)
Event Sourceevent_sourcestringNoExpected event source to match (event type)

Errors​

CodeDescription
UNSUPPORTED_TRIGGER_TYPETrigger type is not one of: manual, webhook, schedule, condition, event
MISSING_SCHEDULESchedule expression is required for schedule trigger but was empty
MISSING_CONDITIONSConditions array is required for condition trigger but was nil
MISSING_EVENT_TYPEEvent type is required for event trigger but was empty
MISSING_SIGNATUREWebhook signature validation enabled but no signature provided

Runtime notes​

  • Wire the 'triggered' boolean to a branch/condition node to gate downstream execution
  • Schedule triggers return a 'next_run' timestamp in result; condition triggers include evaluated 'conditions' array
  • Condition trigger evaluates payload fields against conditions using AND/OR logic — fields come from inputs map
  • Event IDs are auto-generated and unique per invocation (evt_{timestamp}_{counter})

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

Something unclear? Send documentation feedback by email.