NinthDOCS

Features / Stream alerts

Stream alerts

Stream alerts post a card in your server when a Twitch creator goes live, or a YouTube creator goes live or uploads a video or Short. This page is for admins.

Who can manage alerts

All /alerts commands need Manage Server or Administrator. Admins can also manage alerts on the dashboard under Settings, Stream alerts.

Adding an alert

/alerts add platform:Twitch handle:ninth channel:#live role:@Live Pings
OptionRequiredWhat it does
platformYesTwitch or YouTube
handleYesThe Twitch username, or the YouTube handle or channel ID
channelNoWhere to post. Leave it out to use the default channel
roleNoA role to ping with each alert. Leave it out to use the default ping role
liveNoAlert on live streams. Default: on
videosNoAlert on new videos. YouTube only. Default: on
shortsNoAlert on new Shorts. YouTube only. Default: on
custom_messageNoYour own alert text, with placeholders

The bot looks the creator up before saving and refuses handles it can't find or verify, with a message such as No Twitch user found for "ninth". Adding a creator that is already on the list updates that alert and turns it back on.

For YouTube, a channel ID (it starts with UC) always works. If a YouTube handle can't be looked up, paste the channel ID instead. Twitch alerts only work once the operator has connected the bot to Twitch: if not, the bot says Twitch alerts are not configured.

Default channel and role

The default channel and default ping role are set on the dashboard, on the Stream alerts settings page under Defaults. They are used by every alert that doesn't set its own. An alert with no channel of its own and no default channel never posts.

Removing and listing alerts

/alerts remove alert:ninth
/alerts list

/alerts remove has one required option, alert, which suggests your server's alerts as you type. /alerts list shows every alert with its channel, ping role and, for YouTube, which kinds of uploads it alerts on.

Testing an alert

/alerts test platform:YouTube handle:ninth

Shows you a private preview card. It uses the creator's real latest upload, or their live stream on Twitch, when it can find one, and a sample card otherwise. Nothing is posted in your server.

What an alert looks like

The alert is a card in the platform's colour with the creator's name, the stream or video title, the game on Twitch, the viewer count when known, the thumbnail and a Watch on Twitch, Watch on YouTube or Watch Short button. Your alert text sits above the card.

When a Twitch or YouTube stream ends, the bot edits its alert to say the stream has ended.

Templates and placeholders

Without a custom message, the alert text is:

Platform and typeDefault text
Twitch{role}**{streamer}** is live on Twitch!
YouTube live{role}**{streamer}** is live!
YouTube video{role}**{streamer}** posted a new video!
YouTube Short{role}**{streamer}** dropped a new Short!

A custom message can be up to 1000 characters and use these placeholders:

PlaceholderBecomes
{streamer}The creator's name
{title}The stream or video title
{game}The game or category, or "Just Chatting" when there is none
{url}The link to the stream or video
{platform}Twitch or YouTube
{type}live stream, video or short
{viewers}The viewer count, when known
{role}The ping role, followed by a space, or nothing if there is no role
/alerts add platform:YouTube handle:ninth custom_message:{role}New from {streamer}: {title} {url}

Placeholders work in any capitalisation. Names and titles are shown as plain text, so they can't ping anyone.

How often it checks

The bot checks every alert once a minute. It posts once per stream or upload, so a creator who stays live doesn't trigger a second alert until they start a new stream. Videos published before you added the alert are never posted, so a new YouTube alert starts with the creator's next upload.

The bot needs View Channel, Send Messages and Embed Links in the alert channel. The ping role must be mentionable, or the bot needs Mention Everyone, for the ping to notify anyone.