Table of Contents
Pro Chat
Pro Chat feeds the dashboard and Companion chat, overlays, Featured Messages, alerts and chat-driven games. It requires StreamHelpers Pro. The supported source is Restream.io with a separately paid subscription; get or upgrade Restream.io (affiliate link). StreamHelpers no longer hosts individual platform connectors. A very advanced, unsupported user-operated feed is available instead.
This page is the day-to-day guide: pairing, the host Chat page, alerts, celebrations, keeping the stream clean, and Restream.io. The overlay URL parameters are in the overlay reference.
Quick Commands / voice controls can now mute/unmute viewers, replay a saved celebration, advance/clear the queue, change hands-free/queue switches and both overlay switches, and edit effects, notes, uploaded image choices, the independent animation box and monetary tiers. The same guided choices and confirmations work on the dashboard and Companion.
Pairing and connection
Pairing now starts on the dashboard's StreamHelpers Pro page, not on the Chat page.
- Open StreamHelpers Pro.
- In Router pairing, press Pair this router.
- The dashboard opens StreamHelpers. Sign in and approve the router; there is no hosted chat-channel selection.
- Return to the dashboard. The Router pairing card changes to a connected state with Manage on StreamHelpers, Unpair this router and Check again.
- Open Chat → Settings. Under Chat source & host view → Enable chat, enable Pro multi-platform chat and save. Connect Restream.io on the router, then under Chat set-up, select Restream.io, confirm the connected account has an active paid subscription, and save. Manage platform destinations in Restream.
The paid-plan checkbox is your confirmation, not an automatic billing check: Restream's public API does not provide StreamHelpers a verified subscription entitlement. Changing the connected Restream account requires confirming that account again.
The router stores only its protected pairing material. Do not share pairing links, router settings files, overlay URLs, or device secrets.
When signed out, account links open Pro sign-in rather than showing Connection unavailable. The old /chat-connect/account address still works and redirects to the same sign-in. Being signed out does not itself mean your subscription or router pairing was lost.
Chat without Pro Chat
Without a Pro Chat pairing, the Chat tab and chat-driven features have no platform chat feed to read. You can still show overlays that do not need incoming chat, such as trivia questions, poll cards, jokes and What am I looking at?, but the router cannot count votes, score trivia answers, read closest guesses, fill the emoji meter, feature chat lines, or raise chat alerts.
YouTube chat is not a separate free connection in the router dashboard. Bring chat in through the supported paid Restream path or your own very advanced feed. Available platforms and celebration events depend on the chosen service and its platform access.
Very advanced: bring your own feed (unsupported)
Select Very advanced: bring your own feed (unsupported) in Chat set-up. You must operate your own collector and adapter, obtain API keys and platform approvals where required, maintain OAuth tokens, obey quotas and platform terms, and keep the software and server running. StreamHelpers does not host, provide or support those platform connectors. This option requires StreamHelpers Pro but not a Restream subscription.
Configure your HTTPS JSON feed URL and optional Bearer token. Blank token input keeps the saved token; Remove the saved bearer token clears it. Tokens are stored only on the router and redacted from normal backups. Never put keys or passwords in the URL, and never give the adapter your Pro pairing secrets.
The router performs an HTTPS GET. The endpoint must return HTTP 200, a valid certificate, no redirect, and at most 512 KiB within four seconds (two-second connection timeout). Successful responses are shared for two seconds. Return a rolling window with at most 300 messages:
{"messages":[{"id":"twitch:unique-message-id","provider":"twitch","author":"Viewer","message":"Hello!","published_at":"2026-10-08T12:00:00Z"}]}
Every message needs a stable nonempty ID of at most 200 bytes, a lowercase platform name such as twitch or youtube, nonempty author and message, and an ISO-8601 time including timezone. Duplicate IDs are collapsed; messages are sorted by publication time. Invalid messages reject the feed with a visible error. On a connector failure, return a failure rather than pretending the chat is empty.
Optional fields are avatar_url (HTTPS), event_detail, and event_type: chat, youtube_super_chat, youtube_super_sticker, youtube_new_member, youtube_member_milestone, youtube_membership_gift or youtube_gift_membership_received. Your adapter must provide these events to use celebrations. Replies stay in your own tools; this feed is receive-only.
Other tools considered
| Tool | How it fits | Important limit |
|---|---|---|
| Social Stream Ninja | Free/open-source multi-platform collection through a desktop app or browser extension, with WebSocket/API integration options | Source pages or its app must stay running. Platform capture and reply support varies. You need your own adapter; it is not a plug-and-play StreamHelpers integration. |
| Streamer.bot | User-operated automation with documented Twitch, YouTube and Kick WebSocket chat events | Needs an always-running host and a user-built adapter to the JSON contract. |
| Streamlabs Chat Box | An alternative on-stream chat display | Its widget is not this JSON feed. A compatible consolidated export has not been verified, so it is not offered as a drop-in source for StreamHelpers games or alerts. |
A chat overlay URL, chat dock, or WebSocket endpoint is not a compatible JSON feed by itself. Some tools use their own registered OAuth app; custom direct connectors need your own registrations, keys and approvals. Check each tool's current platform terms and documentation.
Host Chat page
The host Chat page is the live-control surface:
- New messages appear with their platform/source and optional avatar.
- The
+and-controls change the host feed font size. The choice is retained by that browser. Featureadds a message to the Featured Messages queue. If the Featured Messages overlay has never been set up, is switched off, or no encoder has shown it for a minute and a half, the page says so and offers to fix it — switching it on for you, or opening its page to copy the address.- A queued message is marked
Queued. - The active featured message is marked
On screen. On screenadvances to the next queued message, or clears the current item if none are queued.- Previously completed highlighted messages are retained in history for 24 hours and shown as featured earlier.
- Each line shows its platform after the time (10:04 PM · YouTube), in the platform's colour. Restream messages retain the viewer's platform; advanced feeds supply their own platform labels. Questions get a blue edge.
- The red line under the header appears only when something needs you: a platform to reconnect in Settings, the chat not answering, or a tap that did not go through (that one clears itself after a few seconds). While chat is arriving normally there is no status line.
- The strip under the header filters the feed to All, Supporters (Super Chats, stickers and memberships) or Questions. The choice is kept by that browser.
- Reply in Restream Chat (on the same strip, when you use Restream.io) opens Restream's own chat in a new tab. The Chat tab only reads chat; Restream Chat is where you type a reply, and it goes to every platform at once. It is the same chat as Open Restream Chat on the Restream.io tab, not the overlay version.
- When something is on the Featured card, the strip says who, and how many cards are waiting. Next moves on (or removes the card when nothing is queued); Clear takes the card down and empties the queue.
- The eye button beside a message takes it off the stream overlays. Tap it again to put it back. The host still sees the line, dimmed and labelled Hidden from stream. Lines kept off stream by the blocked-word or link rules are labelled the same way, with the reason.
- Chime when a Super Chat or membership arrives (Chat settings → host view) plays a short sound and vibrates phones that support it. Browsers only allow sound after one tap on the page.
- On a long stream the page keeps the newest 250 lines while following live (1500 while scrolled back), plus up to 200 supporter lines, so an older phone stays smooth.
- The Look button (eye icon) grabs a still from the camera and asks your AI provider what you are looking at. The answer comes to you; you choose whether it goes on stream. See “What am I looking at?” overlay in the overlay reference.
Chat alerts
Chat alerts, just under the chat header, is your private catch list. It collects the lines you asked to be told about, so they do not scroll past while you are talking. The title says only you see these: viewers never see this list. It is not on the stream and not in any overlay. The only way a line gets from here onto the screen is Feature, which puts it on the Featured Messages card when you press it. The header can carry an Alerts chip (3 alerts) that opens the list from any tab.
- New alerts are marked NEW, and the title counts the unseen ones. Tap an alert to mark it seen.
- Above the list: Show unseen only, Mark all seen, Dismiss seen (removes the ones you have seen), Rules and Test. Test adds a sample alert so you can check the list and the chip.
- Rules opens Chat settings & overlays → Chat alert rules. These rules (What raises an alert) decide what is alertable, and they are yours: keywords or phrases, named viewers, Super Chats and Super Stickers (with an optional minimum amount), new and returning members, gifted memberships, someone's first message this stream, and questions. Each rule can be switched off or renamed, and up to 20 can be kept. Every chat line is checked against them top to bottom, and the first match raises one alert.
- A rule can feature automatically: its matches go straight onto the Featured Messages card, which is on stream, without waiting for you.
- Each alert can be marked Seen, Dismissed, or Featured.
- Only lines that arrive after a rule is saved are matched, so a new rule does not flood the list with old chat.
- The Companion app's Live chat screen shows the same alerts, with a 🔔 count, Feature, Seen and Dismiss. Its alerts follow the rules you set here, and are caught even when no dashboard is open.
- Alerts are for this stream. Clear chat messages (and Start fresh for a new stream on the Go Live tab) clears them; your rules are kept.
- Not alertable: plain YouTube subscribers, and Twitch or Kick follows and subs. Chat carries chat lines, YouTube Super Chats and Stickers, and memberships — the platforms do not send those other events into chat, and neither does Restream.io.
Camera behind the chat
When a Director Mini or a Companion director phone is set up, the Chat page can put its live picture behind the message feed so one screen shows the shot, the chat and the connection at once. The picture comes from a Companion director phone that is sending frames, otherwise from the Director Mini; if neither can give a picture, the page says why instead of showing a blank frame.
- Video turns the picture on and off.
- Full screen expands the picture and chat to the whole display.
- Chat only takes the chat to the whole display with no picture and no chips. It turns the camera feed off rather than covering it, so nothing is spent on a preview nobody is watching. Leave it with the button in the corner, Escape, or the phone's back gesture; the picture returns if it was on. This button is available whether or not a Director Mini is configured.
- Double-tap the Chat tab icon to turn the picture on and go full screen in one step, and double-tap again to come back. The page shows this as a tip until it is dismissed.
- Tapping the picture folds the chat and the chips away so the shot is unobstructed; tapping again brings them back. The eye button in the on-picture controls does the same thing.
- The strip above the picture sets how see-through the chat is and how much of the frame it covers. The handles on the picture itself resize the chat panel directly.
Chips over the picture
A strip of readings sits over the video. Chat settings → Chips over the video chooses what it shows:
| Choice | Shows |
|---|---|
| The same chips as the dashboard header | Whatever is selected in Settings → Header chips |
| Built-in uplink stats | On air state, bitrate, bonded throughput, link count, low batteries, high temperature |
| Nothing | No strip |
Header chips is the default, so the readings you already chose for the header follow you onto the picture instead of being configured twice. The chips are read-only here.
That includes their labels. A chip whose label you switched off in Settings → Header chips is label-free over the picture too, which is where the space it saves is worth the most — the strip runs across a shot rather than across a settings page.
Drag the bar above the strip to move it anywhere on the picture, and the corner handle to set how wide it runs before the chips wrap — so the readings can be kept clear of whatever the shot is framing. With the bar focused, the arrow keys nudge it and Shift with an arrow key moves it further.
In full screen the chips flow around the on-picture controls in the top right rather than running underneath them, so the whole strip stays readable on a phone held sideways.
Low battery and stopped-bonding warnings appear over the picture whatever this is set to. They end a stream, so they are not part of the choice.
Keep the dashboard Chat page or a paired Companion chat screen open to collect Restream chat. Closing all collectors stops new intake; cached messages are not reported as a live connection. An advanced feed's collector runs on your own infrastructure.
Celebrations
The router normalizes supported YouTube events so the Featured Messages overlay can style them independently:
- Super Chat
- Super Sticker
- New member
- Member milestone
- Membership gift
- Gifted membership received
Each celebration uses its own title, accent, hold duration, optional graphic, and graphic position (left, right or above the text). Ordinary featured chat has the same settings under Featured chat.
Each card and monetary tier offers Graphic display: Text only (text), Logo/image + text (both, the existing default), or Logo/image only (text when there is none) (image). Picture-only hides the card title when a graphic is available; missing graphics and image/video load errors restore the title. The chat message/quote, viewer name and event/platform details remain visible. Avatars and celebration effects are separate.
The URL key is graphic_display for Featured chat and graphic_display_<event> for celebrations, e.g. graphic_display_youtube_super_chat. Saved tier styles use graphic_display. Older cards/tiers keep picture-and-text behavior.
A graphic can be:
- an HTTPS link to an image or a WebM/MP4 clip, or
- a file uploaded with Upload on that celebration's card (PNG, JPG, GIF, WebP, SVG up to 3 MB; MP4 or WebM up to 16 MB), or
- a file picked from Media library, which is the same router library the overlay designer uses.
Uploaded files stay on the router, so the overlay does not depend on an outside site during a stream. A transparent WebM makes a good animated celebration. Open Featured Messages → Celebration editor and choose Card to edit from the dropdown. Only that card's options are shown, beside its live preview (stacked on a narrow screen), with the usual Live video background available. Switching cards changes the preview without putting anything on stream, and preserves every card's settings. Send a test card to the live overlay is the explicit on-air test.
Each card can use Confetti, Stars, Hearts, Bubbles or Fireworks, or None. Set its effect duration (1–30 seconds) and particle count (10–200). Celebration animation area is a separate box with its own draggable/resizable preview and X/Y/width/height controls. The message card's position and size are independent: use Full-screen animation area for effects across the whole picture while keeping a small message card. All card types share this area but have their own effect settings. Effects run once per featured message; previews loop. Clearing or muting the active card stops its effect, and reconnecting after an effect has ended does not replay it.
These celebrations are recognised through Restream.io and can be supplied by a compatible advanced feed. Kick subscriptions sent by Restream.io appear as ordinary chat lines.
Particle name: gather & burst makes scattered sparks gather into the featured viewer's actual name, hold it, then explode outward and fade. Choose it from that card's Celebration effect dropdown. Duration controls the whole sequence (40% gathering, 30% holding, 30% bursting); particle count controls name detail, using up to 2,000 tiny particles. Long names fit automatically in the separate animation area. The preview uses the sample viewer's name; your live overlay uses the real featured name. Characters depend on fonts available in your streaming app.
Particle text / thank-you note lets you write, for example, Thank you {name}! (up to 120 characters). {name} becomes the real featured viewer's name; omit it for a fixed message. It works with Particle name: gather & burst and Fireworks: launch into name. Name fireworks launch three rockets upward, burst into your text, hold, then scatter and fade. Both fit the independent animation area.
Custom icons: falling shower rains down up to three uploaded shapes or logos. Choose each image from the router's media library or use Upload image; optional icons 2 and 3 expand individually. Adjust Custom icon size, duration and particle count. Custom shape: gather & burst instead forms the first image's silhouette out of tiny particles, holds, then scatters it. Use a transparent PNG, WebP or SVG for a distinct shape: an opaque image forms a rectangle. Formation samples one decoded frame of a GIF.
Effect images are separate from the card's graphic and use image uploads (PNG/JPG/GIF/WebP/SVG, up to 3 MB), not videos or remote links. Notes and effect images are saved on your router to keep overlay URLs short. After editing, refresh your streaming app's existing Featured source or send it the new URL. Previews update immediately; missing/unreadable effect images show an error without hiding the message card.
Monetary celebration tiers lets you create up to 20 separate celebrations. Select New monetary celebration or an existing tier from its dropdown. Set Amount more than, for example 2 and 5, then its title, colour, timer, animation, note and images beside the preview, and Save celebration tier. Only the highest matching threshold plays: exactly 5 is not more than 5, so the more-than-2 tier still wins. Below all thresholds, the normal card plays.
Leave Currency blank to use the numeric amount for any currency without converting it, or restrict a tier to an exact code/symbol supplied by the event (USD, EUR, $, etc.). Currency-specific tiers, then event-specific tiers win equal-threshold ties. Missing/ambiguous amounts use the normal card; membership counts are not money. Supported monetary events come from Restream or a compatible advanced feed. Advanced feeds can supply a positive dot-decimal event_amount in major currency units and event_currency.
To redo a celebration, scroll back in Live chat and tap Replay celebration, or Play celebration if it has not played yet. It gets a fresh timer/animation and uses your current monetary tiers, including for old messages. Muted users stay blocked and queued cards wait their turn. The Hands-free settings chip on Chat and Hands-free help chip in the editor open the header-preserving Chat settings page where automatic celebrations are configured.
Your chat screen and the on-stream overlays
Chat settings → Your chat screen (host view) only changes the Chat page the host reads. Viewers never see it. What goes on the stream is set on the two overlay builders:
The Chat settings & overlays editor holds everything editable for chat: enablement, source setup, your host-view preferences, alert rules, both overlay editors, hands-free celebrations, safety rules and chat-history clearing. The dashboard header, status chips and navigation stay intact. There is no separate editing menu icon: use Chat's Settings, Overlay and Featured buttons, or the Overlays switches' Edit buttons. Chat stays in the menu when switched off, with a Settings button to enable it again. Old direct editor bookmarks go to the same dashboard view; only the protected browser-source output opens on its own.
The Chat screen also has named Chat and Featured Messages on/off switches, with Showing on stream / Hidden from stream indicators. They control the same state as the Overlays switchboard, for Companion, Director Mini and other streaming apps; switching an overlay off hides it without stopping chat intake or deleting its settings.
- Chat overlay (
premium-chat-overlay.php) shows the running chat. It can stack the platform and name above each message or run them inline, show the platform as a coloured pill, an icon, plain text or not at all, colour names by platform, hide whole platforms, and choose font, weight, text effect, spacing, alignment, entry animation, box style, how many messages show and when they fade. Celebrations can be highlighted with a coloured edge and a chip such as Super Chat $5.00. - Featured Messages (
premium-chat-highlight-overlay.php) shows one big card at a time: a message the host featured, or a celebration.
Common chat bots never appear on the chat overlay, and !commands are hidden unless Show chat bots / Show !commands are ticked in the Chat overlay builder.
Keeping the stream clean
Everything here affects only what viewers see. The host Chat page always shows every message.
- Hide one message: tap the eye button beside it on the Chat page. It comes off the Chat overlay within a few seconds, even if it was already drawn, and off the Featured card if it was on it. Hides last six hours.
- Mute a user: tap Mute user beside their message on Live chat. Their existing and future messages stay off both chat overlays, and their active and queued Featured cards come down. Manual Feature, hands-free celebrations and alert-rule automatic features cannot bypass the mute, including on Companion. You still see their messages and private alerts. Use Unmute user, or edit Featured Messages → On stream: celebrations & safety → Muted users (one exact name per line). Names match ignoring case across all platforms, because the feed has no reliable account ID; another viewer with the same name is also muted. Up to 300 mutes stay until you remove them, including after Clear chat or a restart.
- Moderation delay (Chat overlay builder → What to show): holds every new line back for 3 to 30 seconds before it is drawn, so a line hidden in that time never reaches the stream. Change the delay, then copy the overlay URL into the encoder again.
- Blocked words (Featured Messages editor → On stream: celebrations & safety): a message whose text or viewer name contains one of these whole words is never shown. Blocking
assdoes not hideclass. End a word with*to block everything starting with it:scam*also blocksscammer. - Keep messages with links off stream (Featured Messages editor → On stream: celebrations & safety): hides lines with web addresses.
The rules are applied on the router, so they reach every overlay at once and a word list never appears in an overlay URL.
Clearing the chat for a new stream
Clear chat messages starts the chat over: every message shown so far comes off the Chat page and the Chat overlay, and the Featured card and anything queued behind it come down. It is in two places that do the same thing: Featured Messages editor → Chat history, and the Go Live tab's Start fresh for a new stream, where it sits apart from resetting the stream's numbers so you can do one without the other.
- Nothing is deleted on YouTube, Twitch, Restream.io or anywhere else, and new messages appear as normal.
- A message already on the stream is taken down within a few seconds, without copying the overlay URL again.
- Celebrations that were featured before the clear are not featured again.
Hands-free celebrations
Enable Queue celebrations while Featured Messages is switched off in Featured Messages → On stream: celebrations & safety if you want celebrations to wait while its dashboard switch is off. Switch Featured Messages on from Chat or Overlays to play the waiting cards in arrival order. This also holds manual Feature and alert-rule cards; an interrupted card restarts with its full timer and animation. The queue holds up to 50 cards, plus a paused current card. Clear and user mutes still apply. Keep Chat, Companion's collector or the loaded Featured overlay running to receive new events. This follows the dashboard switch, not external scene changes or whether a streaming app is connected. The option is off by default.
Turn on Feature celebrations automatically (hands-free) in Featured Messages editor → On stream: celebrations & safety, and each Super Chat, Super Sticker and membership is queued on Featured Messages by itself, one after another. It works with supported events from Restream.io or a compatible advanced feed. Only celebrations sent after the option is turned on, and within the last three minutes, are featured; hidden, blocked, muted and already-featured ones are skipped, and Clear is final, so nothing cleared comes back. It runs while the Chat page or the Featured Messages overlay is open.
Send a test card to the live overlay on the Featured Messages builder puts a sample of the chosen celebration on the real overlay, with the settings in its browser source URL. It works with Companion, Director Mini and other streaming apps. Viewers see it too if you are live.
Restream.io and duplicate messages
Restream.io is the supported source. There is no direct-platform fallback or mixed-source merge. Messages collected by multiple dashboard tabs or Companion screens are deduplicated by stable identity. Restream bot reposts and notices are excluded.
Keep at least one dashboard Chat page or paired Companion chat screen open during a live event. Collectors reconnect after interruptions; closing one does not stop another. The router keeps up to 300 messages from the last two hours in memory, not flash. A restart clears this history. Switching source or Restream authorization resets displayed history to avoid mixing accounts.
When a collector connects, the router also loads Restream's saved event chat: the current event, or combined chat across five recent events when not live. These older messages keep their original dates and appear in Companion, the dashboard and overlays without retriggering alerts or automatic featuring. This account-scoped history is cached in memory for five minutes; the combined feed keeps the newest 300 messages across those events. Clear chat messages still hides everything from before the clear. History errors do not stop live chat and are shown as warnings. Very large archives are limited to three 1,000-message pages per event during startup.
What your browser remembers
The following choices are stored in the browser that makes them:
- Host Chat font size
- Where the chips sit over the Chat page's camera picture, and how wide the strip runs
- Whether the full-screen tip on the Chat page has been dismissed
- Chat overlay builder selections
- Featured Messages builder selections, including colours, animations, timing, graphics, preview type, transparent background, and border settings
They survive page reloads on the same browser, and are deliberately not synchronised to another computer, phone or browser profile. The overlay URL you copied into the encoder carries its own settings and stays the source of truth for that browser source — change the builder, then copy the URL again.
When a platform drops out
Restream, its platform connections, or your advanced feed can go offline independently of the router. The Chat page reports collection and feed failures explicitly. Manage platform connections in Restream or your own external tool. Check StreamHelpers Pro → Router pairing → Check again if Pro access has expired.
