Adding a new integration
Step-by-step guide to connecting a new platform, with the required fields for each integration type.
TutorialBeginnerUpdated
This guide walks you through adding a new integration and shows which fields each type needs.
How to add an integration
- Go to Connect from the sidebar.
- Click the + Add Integration button.
- Choose the integration type. The selector includes graphics engines (Viz Flowics, Singular.live, Helmo Graphics), broadcast software (OBS, vMix, CasparCG, Meld Studio), streaming platforms (YouTube, Twitch, Kick, Restream), and Generic HTTP.
- Fill in the configuration: - Name: a descriptive name (for example, "Studio OBS" or "Viz Flowics Production"). - Credentials: API key, token, or connection details depending on the type. - Connection type: Direct or Middleware. - Middleware: if using middleware, select which Helmo Middleware instance to route through.
- Click Save.
Configuration by type
| Type | Required fields |
|---|---|
| Viz Flowics | Graphics Token |
| Singular.live | App Token |
| OBS | Host, Port, Password (optional) |
| vMix | Host, Port |
| CasparCG | Host, Port (AMCP 5250); requires Helmo Middleware |
| Meld Studio | WebSocket URL (default ws://127.0.0.1:13376) |
| Helmo Graphics | None; native connection over Supabase Realtime |
| YouTube / Twitch / Kick / Restream | OAuth authorization (no manual keys, click Connect) |
| HTTP | URL, Method, Headers, Body template |
Testing your integration
After saving, use the Test button on the integration card to verify the connection works. A green status badge means everything is connected.
Security
All API keys and tokens are encrypted at rest. The plain text is never stored in the database. Only a masked version (for example, sk-...xxxx) is visible in the UI.