Skip to main content

Flows

A flow is a plan of one or more steps that Attlaz executes. Each run of a flow is a flow run. A flow is made up of:

  • A trigger — what starts the flow (an API call, a webhook, a schedule, or an incoming email).
  • Logic — conditional steps (for example, an if that branches on the data).
  • Actions — the work the flow performs. An action can be defined in a ready-made template or in your own code.
  • Reports — steps that output or notify, such as sending an email, SMS, or a Slack/Teams message.

Types

TypeDescription
ScheduledRuns automatically on a time-based schedule.
DirectRuns on demand — when its API, webhook, or email trigger fires.

Triggers

A trigger places a flow run request on the queue. Some parameters of the run can be overridden when the trigger fires.

TypeWhen it firesConfiguration
APIWhen the flow's API endpoint is called
WebhookWhen the flow's webhook URL is calledWebhook key
ScheduleAccording to a scheduleSchedule definition
EmailWhen an email arrives in a monitored mailboxMailbox to monitor, email filters

Statuses

A flow run moves through the following statuses. A run stays Pending until a runner actually begins executing it — it does not flip to Running the moment a runner picks it up.

StatusMeaning
PendingThe run is waiting to be handled by a runner.
RunningThe run is being executed by a runner.
CompleteThe run finished successfully.
FailedThe run could not complete.
StoppedThe run was stopped while executing.
CanceledThe run was stopped before a runner picked it up.