Browse the docs

URL

Runs the macro when a switchboard:// link is opened.

A switchboard link route is opened

Keyboard Maestro: PublicWebTrigger

Details #

Opening switchboard://run/<route>?key=<key> runs every macro with a url trigger whose route matches (not case sensitive). The key is a private key stored in Switchboard's settings; links without the right key are refused, so other apps and web pages cannot start your macros. Any other query items arrive as inputs to the macro, as text. The older form switchboard://run?macro=<route>&key=<key> also works.

If no url trigger has that route, the name after run/ is looked up as a macro id or macro name, and that macro runs directly (the key is still required).

{{triggerValue}} is the route.

Secure input does not affect this trigger.

Parameters #

ParameterTypeRequiredValuesWhat it does
routetextYesThe name after run/ in the link. Use letters, digits and dashes.

Every trigger also takes Limits: a cooldown, the first time each day, every nth time, twice within seconds, a chance, only while you are at the Mac, on one Mac, or in a State. See Limits on any trigger.

Examples #

Run from a link
When
  1. The link switchboard://focus is opened
Do
  1. Show “Opened {{triggerValue}}”
Open in Switchboard to try it

Gotchas #

  • A disabled macro with the same route is recorded as disabled in Not fired and does not run.

  • Not fired reasons: disabled, groupOff, scope, paused, conditionFalse.

See also #

Webhook, Phone sensor, Triggers