Controlling the IRL relay via webhook

Your relay can be started, stopped or restarted by calling an address. This works from SAMMI, Streamer.bot, Bitfocus Companion or at the press of a button on a Stream Deck.

A typical case: you have several relays, for example one at home and one in the data center, and only one should ever be active. Otherwise NOALBS switches scenes twice and chat commands such as !start or !stop are executed twice.

Where to find the addresses

In the customer portal, open the relay under Streaming and click Generate webhook addresses on the Relay remote control (webhook) card. You receive five addresses, one per action, in this form:

https://vcontrol.glowfish.de:9786/api/v1/relay/YOUR-KEY/action

The five actions

• start: switches on the relay services.
• stop: stops the relay. All services are ended (SRT, SRTLA, RIST, NOALBS and the chat bot), a running broadcast stops. The relay is then stopped and waits for start.
• neustart: restarts all services.
• allein: switches on this relay and stops all other relays of your customer account.
• status: only returns information and changes nothing.

Call and response

The address is called with GET or POST, without further data. The action takes effect within five seconds. The response comes as JSON, for example:

{"ok":true,"relay":"relay-0001","name":"Relay Zuhause","zustand":"aktiv","sendet":false,"letzte_meldung":"11.11.2026 07:30:12"}

With an unknown key the address responds with status 404. At most 30 calls per minute are possible per relay.

Self-hosted relay

With a relay on your own server, only a small control process keeps running in the container after stopping, waiting for start. You do not need Docker access to your server for this.

Setup in common programs

• SAMMI: Command “HTTP Request”, method GET, with the webhook address as URL.
• Streamer.bot: Sub-action “Fetch URL” with the webhook address.
• Bitfocus Companion: Module “Generic: HTTP Requests”, action GET with the webhook address.
• Stream Deck: a plugin for web requests, for example “API Ready”, method GET.

Switching between two relays: Create two buttons, each with the allein address of the respective relay. One press switches on the selected relay and stops the other.

Security

Anyone who knows the address can control your relay. Treat it like a password and never show it on stream. If in doubt, click Generate new webhook addresses in the customer portal. The old addresses stop working immediately.

You can also restrict calls to certain addresses: on the Relay remote control (webhook) card under Only allow from certain addresses (optional), enter single IPv4 or IPv6 addresses or networks with prefix in the field Allowed IP addresses or networks, separated by commas, for example 203.0.113.7, 198.51.100.0/24. If the field is empty, calls are possible from anywhere. The relay rejects calls from other addresses with status 403 (“Call from this address not allowed”).

If the IP address of your connection changes, for example at home, a single address only fits until the next change. In that case, better enter your provider's network or leave the field empty.

How to set up the relay and receive the stream in OBS is described under Setting up IRL streaming.