General

Allows you to request data from OBS websocket and save it in a variable.

This command should be followed by a Wait until Variable Exists command with an adequate timeout to allow for the OBS Websocket to respond.

OBS Websocket 4.9.1 Protocol

OBS Websocket 5.0 Protocol

The requested value will always be inside an object called responseData (for OBSws 5), but may be inside a second object. You can access it with object dot notation.
For example, if you want to retrieve the Brightness value from a Colour Correction filter, you will notice that it is inside an object called filterSettings. { "filterEnabled": true, "filterKind": "color_filter_v2", "filterSettings": { "brightness": 0.078 }, "filterIndex": 0.0 }. In this case, the Fetch Value will be responseData.filterSettings.brightness.

Use JSON string validator if you want to make sure your formatting is correct.
Be mindful of any trailing commas in your request that will cause OBS to disconnect, such as:

{
  "op": 6,
  "d": {
    "requestType": "GetVersion",  // this trailing commma must be removed
  }
}

Send OBS Request Examples (OBSws 5)

Add 1 to Text GDI+ Source (OBSws 4)

Add 1 to Text GDI+ Source (OBSws 4)

Import JSON button

Similar to ‘Trigger Pull Data’ command, but for OBS Websocket 5 Events.
This command will return a response from the OBS Event Trigger that was used.
More information about all possible OBS events can be found in Official OBS Websocket Documentation.

Enables or disables studio mode in your OBS.

Activates any OBS hotkey without having to manually press it.
You can find the unique name of a hotkey in one of these two locations:

1. For general hotkeys: basic.ini file in C:/Users/USERNAME/AppData/Roaming/obs-studio/basic/profiles/YOUR_CURRENT_PROFILE
2. For source-specific hotkeys: YOURSCENENAME.JSON file in C:/Users/USERNAME/AppData/Roaming/obs-studio/basic/scenes
   Once you open the file, look for HOTKEYS under each source which should have all your unique hotkey names listed.
   
   

Executes hotkey routine.
Does not actually perform the key presses, it simply activates any hotkey action you’ve set.

By default, all OBS events marked as ‘high volume’ are disabled. High volume events must be explicitly subscribed to. This command must be used each time you connect to OBS.