Integrations

Get integrations

GET/api/integrations

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

The settings and live status of OBS, the games, Twitch, Discord and the Stream Deck plugin. Passwords, the Twitch sign-in and the Discord webhook are never sent back.

Responses

200OKapplication/json

obsobject

OBS settings and status.

gamesmap of object

By game id (cs2, dota2).

Show child attributes

enabledboolean

tokenstring

intensitynumber

0 to 1

modestring

One of "blend" "takeover"

namestring

filestring

folderstring

statusobject

Live game status.

twitchobject

Twitch settings, sign-in and status.

discordobject

Discord settings (hasWebhook, the webhook masked) and status.

docsobject

Show child attributes

tryItboolean

The docs site may try API calls.

originsstring[]

streamdeckobject

Show child attributes

availableboolean

downloadstring

releasesstring

uuidstring

runtimeobject

Node.js version and WebSocket client.

403Locked, or not allowed.application/json

errorstringrequired

What went wrong, in a sentence for people.

Request

curl 'http://localhost:8080/api/integrations'

const res = await fetch("http://localhost:8080/api/integrations");
const data = await res.json();
console.log(data);

import requests

res = requests.get(
    "http://localhost:8080/api/integrations",
)
print(res.json())

Response

{
  "obs": {},
  "games": {},
  "twitch": {},
  "discord": {},
  "docs": {
    "tryIt": true,
    "origins": [
      "string"
    ]
  },
  "streamdeck": {
    "available": true,
    "download": "string",
    "releases": "string",
    "uuid": "string"
  },
  "runtime": {}
}

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