Skip to main content

delay


Delay

Type: delay • Category: flow

Description

Wait specified seconds

Parameters

NameTypeDescriptionRequiredDefault
secondsnumberno1
examplebooleanExample worker for testingnofalse
exampleTextstringno"{{ vars['fetch_price_n_n55u']['results'] }}"
exampleText1stringno
myFieldstringyes
symbolautocompleteno
symbol1markdownno

Help

Overview

The Wait worker pauses the execution flow for a configurable number of seconds. It is useful when you need to introduce a deliberate delay between steps in a workflow, such as throttling API calls, waiting for external processes to complete, or simply testing timing behavior. By default, the worker waits for 1 second, but this can be overridden via the seconds parameter.

Inputs

  • seconds (number, default = 1) – The length of the pause in seconds. Must be a non‑negative numeric value.
  • example (boolean, default = false) – When set to true, the worker runs in a lightweight test mode that logs its activity without actually delaying the workflow.
  • exampleText (string, default = "{{ vars['fetch_price_n_n55u']['results'] }}") – A placeholder string that can be used to demonstrate variable interpolation in documentation or testing scenarios.
  • exampleText1 (string) – An additional free‑form text field with no preset default; useful for custom notes or tags.
  • myField (string, required) – A mandatory text field; its purpose is defined by the surrounding workflow and must be supplied by the caller.
  • symbol (autocomplete) – Provides an autocomplete dropdown of predefined symbols; primarily intended for UI assistance.
  • symbol1 (markdown) – Accepts markdown‑formatted content, allowing rich‑text descriptions or instructions to be attached to the worker instance.

Minimal Example Usage

Below is a concise illustration of how to configure the Wait worker within a workflow definition:

worker: wait
params:
seconds: 5
myField: "mandatory value"
example: false

In this example the worker will pause the workflow for 5 seconds before proceeding to the next step. The required myField is supplied, while optional parameters retain their default values. If you set example to true, the worker will log the intended wait duration without actually sleeping, which is handy for rapid testing.