Actions58
- Streaming Actions
- Recording Actions
- Virtual Camera Actions
- Scene Actions
- Source Actions
- Audio Actions
- Filter Actions
- Transition Actions
- Media Actions
- Text Source Actions
- Hotkey Actions
- Profile Actions
- Screenshot Actions
- General Actions
Hotkey → Trigger Hotkey
AI-generatedSummary
Trigger a named hotkey in OBS Studio via its WebSocket interface.
Inputs
- Hotkey Name (required) — The name of the hotkey to trigger, matching an OBS hotkey identifier like 'OBSBasic.StartStreaming'.
Output shape
A single JSON object indicating success or error with fields such as 'success' (boolean), 'message' (string), and 'hotkeyName' (string).
The operation triggers the configured hotkey asynchronously and returns a success message upon completion. In case of error, an error message is returned. No additional data about the hotkey is returned.
Examples
Example 1: Trigger the OBS hotkey named 'OBSBasic.StartStreaming' to start streaming.
Set 'Hotkey Name' input to 'OBSBasic.StartStreaming'. After execution, output confirms triggering the hotkey.