Skip to content

Trigger

A Trigger is the node a run starts from. A workflow needs at least one before you can publish it, and no edge may lead into one. Its Type decides when it fires on its own. Any trigger can also start a run from Run draft in the builder or from the API.

How triggers listen, what pausing does and how app events are delivered is on Triggers. This page lists the node’s settings.

Field What it does
Type Manual, Schedule or App event.
Status, under General Active or Disabled. A disabled trigger never listens, and the workflow’s other triggers keep listening.

A Manual trigger never fires on its own. In the app, it starts draft runs from the builder’s Test tab. A published version starts from a Manual trigger only through the API.

Field What it does
All day Off: the run starts at a time of day. On: it starts at midnight.
Starts on, At The date and time of the first run, such as 09:00. The date is required.
Ends on, At Optional. No run starts after this point. With All day, the whole end date is included.
Repeats Once, Hourly, Daily, Weekly, Monthly or Yearly. All day has no Hourly.

Dates and times are in the time zone of the browser that publishes the version. Each version records its time zone, shown in the workflow’s run history. A start date in the past with Repeats set to Once never runs.

On the canvas, the node reads like “Daily from Oct 3”, or “Set a start date” until it has one.

Field What it does
App One of the apps your organization has connected that offers events.
Connection The account of that app to listen on. When the app has one connection, it is chosen for you.
Event What to listen for, such as a new Slack message. Its description shows below.
Filter fields They depend on the event, and “(required)” marks the ones it needs. A blank field matches anything.

Some filter fields are a searchable list read from the connection, such as a Slack channel, with Any at the top. The others are text boxes.

If no app with events is connected, the panel says “Connect an app with triggers in Apps to use it here.” Only owners and admins connect apps. See Connecting apps.

On the canvas, the node shows the app’s logo, the event and the account. Once published, it also shows whether it is listening. See Triggers.

The payload is what the run started with:

How the run started Payload
Run draft What you typed in the Test tab
API The request’s input
Schedule {"eventType": "schedule", "scheduledAt": "<ISO 8601 time>"}
App event The event’s payload, as the app’s connector delivers it
Field What it holds
eventType What started the run: manual, api, schedule or event
timestamp When the trigger fired, in ISO 8601
payload The payload, as JSON when it is JSON, otherwise as text

Any step reads the payload of the trigger that fired as {{ trigger }} and its fields as {{ trigger.<field> }}. In a workflow with several triggers, {{ nodes.<trigger id>.payload }} reads one trigger in particular. The step right after the trigger reads the payload text as {{ input }}. See Templates and variables.