Reference Triggers Obs

OBS triggers

Also on the Cuebot Docs site.

Any OBS event (advanced)

Runs for any message OBS sends, so you can react to things Cuebot has no special trigger for. For advanced users.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Event type	Only react to this kind of OBS message, like "InputActiveStateChanged". Leave empty to react to every message.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%eventType%	The kind of OBS message
%eventData%	All the details OBS sent, as raw text
%obsEvent.event%	The kind of OBS message (same as eventType)

Type id: obs.event

Connected

Runs when Cuebot connects to OBS. Handy for setting up your scene or sending yourself a "ready" message.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from

Type id: obs.connected

Current transition changed

Runs when you pick a different transition type in OBS (not when a transition plays).

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Transition	Only react when this transition is picked, like "Fade". Leave empty for any transition.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%transitionName%	The transition that is now selected

Type id: obs.transitionChanged

Disconnected

Runs when Cuebot loses its connection to OBS, for example when you close OBS.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from

Type id: obs.disconnected

Filter state changed

Runs when a filter (an effect on a source, like a color tweak) is switched on or off.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Source	Only react to this source (or scene), typed exactly as OBS shows it, like "Webcam". Leave empty for any.
Filter	Only react to this filter, typed exactly as OBS shows it, like "Color Correction". Leave empty for any filter.
State	Pick Enabled to react when it turns on, Disabled when it turns off, or Any for both. Options: Any, Enabled, Disabled. Starts as: Any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%sourceName%	The source or scene the filter belongs to
%filterName%	The name of the filter
%filterEnabled%	True when the filter is now on

Type id: obs.filterStateChanged

Input mute changed

Runs when an audio source (like your microphone) is muted or unmuted in OBS.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Input	Only react to this audio source, typed exactly as OBS shows it, like "Mic/Aux". Leave empty for any.
State	Pick Muted to react when it is muted, Unmuted when it is unmuted, or Any for both. Options: Any, Muted, Unmuted. Starts as: Any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%inputName%	The name of the audio source
%inputMuted%	True when the source is now muted

Type id: obs.inputMuteChanged

Input volume changed

Runs when the volume of an audio source changes in OBS.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Input	Only react to this audio source, typed exactly as OBS shows it, like "Mic/Aux". Leave empty for any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%inputName%	The name of the audio source
%inputVolumeDb%	The new volume in decibels (0 is full volume, lower numbers are quieter)
%inputVolumeMul%	The new volume as a multiplier (1 is full volume, 0 is silent)

Type id: obs.inputVolumeChanged

Media action triggered

Runs when someone presses play, pause, stop, restart, next or previous on a media source in OBS.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Input	Only react to this source, typed exactly as OBS shows it, like "Intro Video". Leave empty for any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%inputName%	The name of the media source
%mediaAction%	What was pressed: play, pause, stop, restart, next or previous

Type id: obs.mediaAction

Media playback ended

Runs when a media source finishes playing. Handy for hiding a video after it ends.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Input	Only react to this source, typed exactly as OBS shows it, like "Intro Video". Leave empty for any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%inputName%	The name of the media source

Type id: obs.mediaEnded

Media playback started

Runs when a media source (a video or sound file) starts playing in OBS.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Input	Only react to this source, typed exactly as OBS shows it, like "Intro Video". Leave empty for any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%inputName%	The name of the media source

Type id: obs.mediaStarted

Plugin message (advanced)

Runs when an OBS plugin sends its own message through OBS. For plugin fans; most people never need it.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Vendor name	Only react to messages from this plugin, like "obs-browser". Leave empty for any plugin.
Event type	Only react to this kind of message from the plugin. Leave empty for any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%vendorName%	The plugin that sent the message
%vendorEventType%	The kind of message
%eventData%	The extra details the plugin sent, as raw text

Type id: obs.vendorEvent

Preview scene changed

Runs when the scene in the preview side of OBS studio mode changes. Only happens while studio mode is on.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Scene	Only react to this scene, typed exactly as OBS shows it, like "Just Chatting". Leave empty for any scene.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%sceneName%	The new preview scene

Type id: obs.previewSceneChanged

Profile changed

Runs when you switch to a different OBS profile (a saved set of settings).

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%profileName%	The name of the new profile

Type id: obs.profileChanged

Recording file changed

Runs when OBS starts a new recording file, for example when it splits a long recording into parts.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%newOutputPath%	The path of the new recording file

Type id: obs.recordFileChanged

Recording paused

Runs when you pause a recording in OBS.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%outputPath%	The recording file, if OBS says

Type id: obs.recordPaused

Recording resumed

Runs when you continue a paused recording in OBS.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%outputPath%	The recording file, if OBS says

Type id: obs.recordResumed

Recording started

Runs when OBS starts recording.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%outputPath%	Where the recording file is being saved, if OBS says

Type id: obs.recordStarted

Recording stopped

Runs when OBS stops recording.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%outputPath%	Where the finished recording file was saved, if OBS says

Type id: obs.recordStopped

Replay buffer saved

Runs when OBS saves a replay clip. Handy for posting the clip or playing a sound.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%savedReplayPath%	The path of the saved replay file

Type id: obs.replayBufferSaved

Replay buffer started

Runs when the OBS replay buffer (the "save the last moments" feature) starts.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from

Type id: obs.replayBufferStarted

Replay buffer stopped

Runs when the OBS replay buffer stops.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from

Type id: obs.replayBufferStopped

Scene changed

Runs when OBS switches to another scene on the live output. Great for changing lights or sending a message for certain scenes.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Scene	Only react to this scene, typed exactly as OBS shows it, like "Just Chatting". Leave empty for any scene.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%sceneName%	The scene OBS switched to
%previousScene%	The scene OBS was on before

Type id: obs.sceneChanged

Scene collection changed

Runs when you switch to a different OBS scene collection (a saved set of scenes).

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%sceneCollectionName%	The name of the new scene collection

Type id: obs.sceneCollectionChanged

Screenshot saved

Runs when OBS saves a screenshot.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%savedScreenshotPath%	The path of the screenshot picture

Type id: obs.screenshotSaved

Source visibility changed

Runs when a source (like a camera or image) is shown or hidden in a scene.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Scene	Only react to this scene, typed exactly as OBS shows it, like "Just Chatting". Leave empty for any scene.
Source	Only react to this source, typed exactly as OBS shows it, like "Webcam". Leave empty for any source.
State	Pick Visible to react when it appears, Hidden when it disappears, or Any for both. Options: Any, Visible, Hidden. Starts as: Any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%sceneName%	The scene the source is in
%sourceName%	The name of the source
%visible%	True when the source is now shown, false when hidden

Type id: obs.sourceVisibilityChanged

Stream started

Runs when OBS starts streaming. Good for a "going live" message.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from

Type id: obs.streamStarted

Stream stopped

Runs when OBS stops streaming. Good for an "end of stream" clean-up.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from

Type id: obs.streamStopped

Studio mode changed

Runs when you turn OBS studio mode (a preview screen before going live) on or off.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
State	Pick Enabled to react when studio mode turns on, Disabled when it turns off, or Any for both. Options: Any, Enabled, Disabled. Starts as: Any.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%studioModeEnabled%	True when studio mode is now on

Type id: obs.studioModeChanged

Transition duration changed

Runs when you change how long OBS transitions take.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%transitionDuration%	The new length of the transition, in milliseconds (1000 = one second)

Type id: obs.transitionDurationChanged

Transition ended

Runs when a scene transition has finished.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Transition	Only react to this transition, like "Fade" or "Stinger". Leave empty for any transition.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%transitionName%	The name of the transition

Type id: obs.transitionEnded

Transition started

Runs when a scene transition (the fade or wipe between scenes) begins.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.
Transition	Only react to this transition, like "Fade" or "Stinger". Leave empty for any transition.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from
%transitionName%	The name of the transition

Type id: obs.transitionStarted

Virtual camera started

Runs when the OBS virtual camera is turned on.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from

Type id: obs.virtualCamStarted

Virtual camera stopped

Runs when the OBS virtual camera is turned off.

Setting	What to put in
Connection	Only react to this OBS connection (type its name from your OBS settings in Cuebot). Leave empty to react to all of them.

Variables you get

Variable	What it holds
%obsConnection%	The name of the OBS connection this came from

Type id: obs.virtualCamStopped