Streamheim API-Handbuch
Zum Panel →
TOOLS VERBINDEN

Externe Tools an Streamheim

Stream Deck · Streamer.bot · Discord · eigene Overlays

Alles Einrichten passiert im Panel unter Setup → Tools verbinden. Dort findest du Ausprobieren, Zugangsschlüssel, Benachrichtigungen und Vorlagen zum Kopieren.

Inhalt

Kurzüberblick — die Navigation links führt zu allen Kapiteln.

  1. Schnellstart im Panel
  2. Was du damit machen kannst
  3. Zugangsschlüssel
  4. Stream Deck
  5. Streamer.bot
  6. Benachrichtigungen (Webhooks)
  7. Sounds & Bibliothek
  8. Sicherheit
  9. Für Entwickler (REST & JSON)
  10. FAQ

Schnellstart im Panel

So startest du in 2 Minuten
  1. Im Panel: Setup → Tools verbinden öffnen
  2. Tab Ausprobieren — Funktion wählen, ausführen, Ergebnis lesen und JSON darunter prüfen
  3. Für Stream Deck o. Ä.: Tab Zugangsschlüssel — neuen Schlüssel anlegen, Berechtigungen ankreuzen, kopieren
  4. Fertige Texte: Tab Vorlagen — URL + Schlüssel einsetzen, in dein Tool einfügen

Du musst kein Programmierer sein. Wer Stream Deck oder Streamer.bot schon nutzt, trägt nur URL und Schlüssel ein.

Was du damit machen kannst

Du willst …Lösung
Sound per Stream-Deck-TasteZugangsschlüssel + Vorlage „Sound abspielen“
Bei Sub automatisch Sound oder RadStreamer.bot → Web Request bei Twitch-Event
Watchtime-Top-10 auf eigener SeiteAPI abfragen (nur lesen) — Vorlage im Panel
Discord-Ping wenn Gewinner gezogenTab Benachrichtigungen → Discord-Webhook-URL
Eigenes Live-Overlay mit Echtzeit-DatenVorlage „Live-WebSocket“ + Schlüssel mit Live-Berechtigung

Zugangsschlüssel

Ein Schlüssel ist wie ein Passwort für dein Tool — nur für deinen Kanal, mit klaren Rechten.

Im Panel

  • Setup → Tools verbinden → Zugangsschlüssel
  • Name vergeben (z. B. „Stream Deck“)
  • Haken setzen: Was darf dieses Tool? (z. B. nur Sound, nicht alles)
  • Schlüssel erscheint einmal — sofort kopieren und sicher speichern
  • Bei Leak oder Wechsel: Widerrufen — alter Schlüssel ist sofort ungültig

Wer darf Schlüssel anlegen?

RolleAnlegen
Streamer / InhaberJa
Team mit Setup-BearbeitungJa (für diesen Kanal)
Nur AnsehenNein

Berechtigungen — in Klartext

Im Panel heißt es …Bedeutet
Status lesenLive?, Bot im Chat?, Timer
Watchtime lesenBestenliste, User-Statistik
Punkte lesenCommunity-Punkte, Shop-Liste
Gewinnspiel lesenLäuft gerade eins? Wie viele Teilnehmer?
Sound auslösenSound im Stream abspielen
GlücksradRad drehen (echte Stream-Aktion)
Gewinnspiel steuernStarten / Gewinner ziehen
Stream-TimerTimer starten/stoppen
Live-OverlayEchtzeit-Events per WebSocket
Webhooks verwaltenBenachrichtigungen per API anlegen
So sendet dein Tool den Schlüssel mit
Authorization: Bearer DEIN_SCHLUESSEL

Basis-Adresse für alle Aufrufe:

https://panel.streamheim.de/api/v1/channel/…

Stream Deck

⏱ Ca. 3 Minuten · Vorlage im Panel unter Vorlagen → Stream Deck

  1. Schlüssel mit Berechtigung „Sound auslösen“ anlegen
  2. In Stream Deck: Plugin Bar Raider Web Request oder Streamer.bot als Zwischenschritt (Sounds brauchen POST, nicht nur „Website öffnen“)
  3. Vorlage aus dem Panel kopieren — Sound-URL aus Tab Ausprobieren → Sound-Bibliothek oder aus dem JSON dort
  4. Header Authorization: Bearer … setzen, testen

Sound läuft in der OBS-Browser-Quelle — nicht auf dem PC-Lautsprecher der Zuschauer.

Streamer.bot

⭐ Empfohlen für Automatik (Sub, Kanalpunkte, Timer)

  1. Aktion Web Request: POST auf …/api/v1/channel/actions/sound/play
  2. Header: Authorization + Content-Type: application/json
  3. Body (Beispiel):
{
  "url": "/channel-sounds/DEINE_ID/mein-sound.mp3",
  "volume": 80
}

volume: 0–100 (Prozent) oder 0–1 — beides funktioniert.

Trigger z. B. „Twitch → New Subscriber“ oder „Channel Point Redemption“ → dieselbe Web-Request-Aktion.

Nur Daten lesen (Watchtime)

GET https://panel.streamheim.de/api/v1/channel/watchtime/top?limit=10
Authorization: Bearer DEIN_SCHLUESSEL

Antwort ist JSON — im Tab Ausprobieren siehst du dieselbe Struktur lesbar und als Roh-JSON.

Benachrichtigungen (Webhooks)

Statt alle paar Minuten abzufragen, meldet sich Streamheim bei dir — z. B. an Discord oder Power Automate.

  1. Panel → Tools verbinden → Benachrichtigungen
  2. Name + HTTPS-URL (Discord-Webhook, Power-Automate-Link, …)
  3. Events wählen — z. B. Gewinner gezogen, Stream live
  4. Geheimnis beim Anlegen kopieren (zur Signatur-Prüfung)
EventWann
stream.live / stream.offlineStream startet / endet
giveaway.winnerGewinner gezogen
wheel.resultGlücksrad-Ergebnis
sound.playedSound gestartet
points.purchaseShop-Einlösung (Community-Punkte)
bot.alertBot-/Token-Problem

Max. 8 Benachrichtigungen pro Kanal. Nur https://, keine internen Adressen.

Sounds & Bibliothek

GET /api/v1/channel/sounds liefert:

  • Deine Sounds — hochgeladen im Panel
  • Streamheim-Bibliothek — geteilte Plattform-Sounds (im Ausprobieren-Tab als eigene Gruppe)

Zum Abspielen per API nur URLs aus dieser Liste verwenden — eigene Pfade oder Bibliothek-Einträge.

Sicherheit

  • Schlüssel niemals im Chat, auf Stream oder in öffentlichem GitHub
  • Pro Tool nur die Berechtigungen geben, die wirklich nötig sind
  • Gelegentliche Limits (z. B. Sound-Anzahl pro Minute) schützen vor Missbrauch
  • Schlüssel geleakt? Sofort widerrufen im Panel
  • Die API kann keine Twitch-Moderation (Ban, Timeout) — bewusst so

Für Entwickler (REST & JSON)

Technische Referenz — im Panel unter Ausprobieren kannst du jeden Endpunkt testen und das JSON sehen.

MethodePfadHinweis
GET/statusLive, Bot, Timer
GET/watchtime/top, /watchtime/user?login=Modul Watchtime
GET/points/user, /points/shopModul Community-Punkte
GET/giveaway, /soundsStatus / Bibliothek
POST/actions/sound/play{ url, volume? }
POST/actions/wheel/spinoptional Metadaten
POST/actions/giveaway/start, …/drawModul Gewinnspiel
POST/actions/stream/start, …/stopStream-Timer

Live-WebSocket (Socket.IO)

Scope „Live-Overlay“ — Vorlage im Panel. Verbindung:

socket.emit("join-api-live", { apiKey: "DEIN_SCHLUESSEL" });
socket.on("api:live", (msg) => { /* msg.event, msg.data */ });

FAQ

Sehen Zuschauer meinen Schlüssel?

Nein — solange du ihn nicht öffentlich postest. Nur lokal in Tools eintragen.

Ersetzt die API Chat-Befehle?

Nein — sie ergänzt sie. Zuschauer nutzen weiter !sound usw.; du steuerst zusätzlich per Deck oder Bot.

StreamElements parallel?

Ja. Streamheim-API aus SE/Streamer.bot triggern, ohne doppelte Chat-Befehle.

Wo teste ich ohne externes Tool?

Panel → Tools verbinden → Ausprobieren — lesbare Ansicht + JSON darunter.

Stand: Juli 2026 · API v1 · Panel: Setup → Tools verbinden