Pulse

The ui.json pulse allows for regular running of a script as part of your Alfred UI.

If the pulse script outputs JSON, this will be interpreted as JSON Actions on the end of the event thread.

Tip

It's possible to reconfigure the Pulse in the script's output using the JSON Actions pulse property.

For example, you can disable the pulse at any point by setting the interval to 0.

Properties

src
STRING
Required

The script path, can be a relative path.

args
STRING | ARRAY

The arguments to pass to the script. Due to the background nature of the pulse, arguments can be of type STRING, or variables, but not UI values.

Variables will be stored as placeholders and resolved on every pulse.

Note

The pulse is designed to be a very lightweight and high performance trigger. As such, composite variable strings cannot be used for args.

now
BOOL
Default: false

Set to true for a single pulse to be triggered immediately on the end of the event thread. This won't affect the timing of the configured pulse.

intervalmode
ENUM
Default: "delay"
Value Description
"delay" Will wait for the interval amount after the previous script has completed.
"regular" Will try to fire as close to every interval as possible.
interval
DOUBLE
Default: 0, Range: 0.1-1000

How often to fire the pulse in seconds.

Set to 0 to disable the pulse.