OBS Event

Explore all supported OBS Studio Events on their WebSocket protocol documentation

The variables populated by this trigger are different depending on the Event parameter.

For example, given the following event data from OBS:

example.json

{
  event: "SceneListChanged",
  scenes: [
    {
      sceneIndex: 0,
      sceneName: "Be Right Back",
      sceneUuid: "1234-5678-9abcd"
    }
  ]
}

The following variables will be populated:

Name	Type	Value
`obsEvent.event`	`string`	`"SceneListChanged"`
`obsEvent.scenes[0].sceneIndex`	`int`	`0`
`obsEvent.scenes[0].sceneName`	`string`	`"Be Right Back"`
`obsEvent.scenes[0].sceneUuid`	`string`	`"1234-5678-9abcd"`

Parameters

Connectionrequired

Select

Select the configured OBS Studio Connection to connect to

Any - trigger on events from any OBS connection
Default - trigger on events from the default OBS connection

Eventrequired

Select

Select an event to Trigger on

Variables

The following variables will be populated when this trigger executes:

		Description
`obs.host`	`string`	The IP Address of the OBS connection Example: `127.0.0.1`
`obs.id`	`string`	The connection id
`obs.name`	`string`	The name of the connection Example: `Main OBS`
`obsEvent.*`	`string`	The properties of the OBS event, as flattened JSON keys.

		Description
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access, read more Example: `TwitchChatMessage`
`actionId`	`Guid`	The unique ID of the action being executed Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`actionName`	`string`	The name of the action being executed Example: `My Action`
`actionQueuedAt`	`DateTime`	The timestamp of when action was queued Example: `12/21/2023 9:25:21 AM`
`eventSource`	`EventSource`	The service of the event which triggered the action. This will not always exist and requires C# to access, read more Example: `twitch`
`runningActionId`	`Guid`	The unique ID of this running action instance within the queue Example: `c83dd939-9f86-4435-b07c-b6e7e3eef134`
`triggerCategory`	`string`	The category of the trigger which executed the action Example: `Twitch/Chat`
`triggerId`	`Guid`	The unique id of the trigger with executed the action Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`triggerName`	`string`	The name of the trigger which executed the action Example: `Chat Message`

OBS Disconnected

Trigger for when OBS is Disconnected

OBS Recording Started

Trigger for when an OBS Recording is Started