General

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

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
  }
}

Use the dropdown arrow next to the OBS Command (JSON) box to make use of the premade templates to assist you (OBSws 5 only).

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.

OBS WebSocket 5 Request: SetStudioModeEnabled

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.
   
   

OBS WebSocket 5 Request: TriggerHotkeyByName

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

OBS WebSocket 5 Request: TriggerHotkeyByKeySequence

Example: keyId = "OBS_KEY_F5" with keyModifiers = {"shift": true} triggers Shift+F5.

Controls the OBS Virtual Camera — Start, Stop, or Toggle it using the dropdown.

The OBS Virtual Camera creates a virtual webcam device that other applications (Zoom, Discord, Teams, etc.) can use as a camera input. It is included by default in OBS 26.1 and later — no additional plugin required.

OBS WebSocket 5 Request: StartVirtualCam / StopVirtualCam / ToggleVirtualCam

ToggleVirtualCam returns an outputActive boolean indicating whether the Virtual Camera is now active. Use Get Virtual Camera Status to check the current state before toggling.

Gets the current active state of the OBS Virtual Camera and saves it as a boolean.

Use this to check whether the Virtual Camera is currently running before toggling it, or to update a button’s appearance based on the camera state.

Saved Value:

OBS WebSocket 5 Request: GetVirtualCamStatus

No request fields.

Example SAMMI Response:

false

Gets OBS performance statistics (CPU, memory, FPS, disk space, etc.) and saves them as an object.

Use Object Get Variable to read individual fields from the returned object.

Saved Payload:

OBS WebSocket 5 Request: GetStats

No request fields.

Example SAMMI Response Object:

{
  "cpuUsage": 2.5,
  "memoryUsage": 1024.5,
  "availableDiskSpace": 102400.0,
  "activeFps": 60.0,
  "averageFrameRenderTime": 5.2,
  "renderSkippedFrames": 0,
  "renderTotalFrames": 36000,
  "outputSkippedFrames": 0,
  "outputTotalFrames": 36000,
  "webSocketSessionIncomingMessages": 5,
  "webSocketSessionOutgoingMessages": 5
}

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.

OBS WebSocket 5: Event Subscriptions (sent during Identify handshake, op code 1)

When SAMMI connects to OBS, it sends an Identify message with an eventSubscriptions bitmask. This command lets you enable additional high-volume subscriptions at runtime using a Reidentify request (op code 3).

Use OBS Event Pull command in an OBS Trigger button to receive data from these events.