Integrations

Change OBS

PATCH/api/integrations/obs

Admin. Needs an unlock token (x-tempolight-token) while a PIN lock is set; without a lock, anyone can call it.

Connects to OBS (WebSocket v5): Tempolight scenes for OBS scenes, scenes when streaming or recording starts, and a tally light.

Request body application/json

enabledboolean

urlstring

passwordstring

clearPasswordboolean

sceneMapobject[]

Show child attributes

obsstring

An OBS scene.

scenestring

A Tempolight scene id.

onStreamStartstring

onStreamStopstring

onRecordStartstring

tallyobject

Show child attributes

enabledboolean

whenstring

One of "recording" "streaming" "either"

targetstring

colorstring

Responses

200OKapplication/json

object

The OBS settings and status.

400The body isn't valid JSON, or a value is wrong.application/json

errorstringrequired

What went wrong, in a sentence for people.

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

curl -X PATCH 'http://localhost:8080/api/integrations/obs' \
  -H 'content-type: application/json' \
  -d '{
  "enabled": true,
  "url": "ws://127.0.0.1:4455",
  "sceneMap": [
    {
      "obs": "Just chatting",
      "scene": "chill"
    }
  ]
}'

const res = await fetch("http://localhost:8080/api/integrations/obs", {
  method: "PATCH",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({
    "enabled": true,
    "url": "ws://127.0.0.1:4455",
    "sceneMap": [
      {
        "obs": "Just chatting",
        "scene": "chill"
      }
    ]
  }),
});
const data = await res.json();
console.log(data);

import requests

res = requests.patch(
    "http://localhost:8080/api/integrations/obs",
    json={
        "enabled": True,
        "url": "ws://127.0.0.1:4455",
        "sceneMap": [
            {
                "obs": "Just chatting",
                "scene": "chill"
            }
        ]
    },
)
print(res.json())

Response

{}

{
  "error": "OBS's address looks like ws://127.0.0.1:4455"
}

{
  "error": "Settings are locked. Unlock with the PIN in Settings."
}