How it works
- Give the webhook a name made of lower-case letters, digits and hyphens, up to 48 characters, such as stream-start.
- Only routines that have this trigger can be started this way, and only programs you paired with a 4-digit code, running as your own Windows user, can call it.
- Whatever the program sends, JSON or text, arrives with the trigger along with the program's name; treat it as outside data and check it before using it in a path or address.
- The local API is off by default; until you turn it on in Settings, the trigger shows that it's waiting.
Routines that use it
Script starts a scene
A PowerShell script posts to stream-start with a scene name, and the routine switches it with OBS: switch scene.
Stream Deck button
A paired Stream Deck plugin calls a webhook that runs Set volume and Mute an app.
Build finished
A local build script calls build-done, and the routine shows a banner and plays Speak text.
Settings
| Setting | What it does |
|---|---|
| Name | The webhook's name: lower-case letters, digits and hyphens. A program calls POST http://127.0.0.1:57250/v1/hooks/<name> with its paired token. |
Good to know
- Needs KeyRoutines Pro and the local API turned on.
- Only listens on this PC; websites and other computers can't call it.
Questions
- Can I trigger a KeyRoutines routine from a script?
- Yes. Add a Webhook trigger, turn on the local API, pair your script, and have it send a POST to the webhook's name.
- Can a website or another PC call my webhook?
- No. Only paired programs on the same PC, running as your Windows user, are accepted, and websites are refused.