User Tools

Site Tools


trigger:URL

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
trigger:URL [2017/09/04 22:29]
peternlewis
trigger:URL [2018/05/22 15:03] (current)
JMichaelTX Rewrite usage and add examples.
Line 1: Line 1:
 +====== URL Trigger ======
 +
 Any active macro can be triggered using the kmtrigger: scheme with a URL like this: Any active macro can be triggered using the kmtrigger: scheme with a URL like this:
  
-    kmtrigger://​macro=MacroName&value=Value+    kmtrigger://​macro=<​MacroNameOrUUID>​[&value=<​TriggerValue>​]
     ​     ​
 +where
 +
 +    "<​MacroNameOrUUID>"​ is either the URL encoded Macro Name, or the Macro UUID
 +    "​[&​value=<​TriggerValue>​]"​ is the option to pass "<​TriggerValue>"​ as the Macro %TriggerValue%
 +       • Do not include the square brackets [ ] in the actual URL.
 +       • Do not include the "​%value="​ without a value.
 + 
 +You can pass a trigger value to the macro by adding the "​value"​ query parameter to the URL.  The parameter is available to the macro as the [[token:​TriggerValue|%TriggerValue% text token]] (v7.0+).
 +   
 +===== Examples =====
 +
 +    kmtrigger://​macro=Prompt%20With%20List%20%40TEST
 +    kmtrigger://​macro=984A3DBF-5B70-4031-979F-5AD44E3B24A5
 +    kmtrigger://​macro=Prompt%20With%20List%20%40TEST&​value=MyTriggerValue
 +    kmtrigger://​macro=984A3DBF-5B70-4031-979F-5AD44E3B24A5&​value=MyTriggerValue
 +
 Note that a macro must be active (that is, it must be enabled, and the macro group that contains it must be enabled and active) in order for the macro to be triggered by any means including via URL. Note that a macro must be active (that is, it must be enabled, and the macro group that contains it must be enabled and active) in order for the macro to be triggered by any means including via URL.
  
-You can pass parameter to the macro by adding the *value* field to the URL.  The parameter is available to the macro as the [[token:​TriggerValue|%TriggerValue% text token]] (v7.0+).+You can get the `kmtrigger` for a macro by clicking on the "or by URL:" popup in the Trigger section of the macro. 
  
 ===== See Also ===== ===== See Also =====
trigger/URL.txt · Last modified: 2018/05/22 15:03 by JMichaelTX