Skip to main content

Documentation Index

Fetch the complete documentation index at: https://teambattles.gg/docs/llms.txt

Use this file to discover all available pages before exploring further.

Get notified when streams go live, recordings start, or errors occur.

​
Notification Types

EventDescription
Stream LiveA monitored channel goes live
Recording StartedRecording has begun
Recording CompleteRecording finished successfully
Recording FailedRecording encountered an error
Processing CompletePost-processing finished
Storage WarningApproaching storage limit
Storage FullStorage quota reached

​
Discord Webhooks

Send notifications to a Discord channel.

​
Setup

1

Create Webhook

In Discord: Server Settings → Integrations → Webhooks → New Webhook
2

Copy URL

Copy the webhook URL
3

Add to Battles Record

Navigate to Settings → Notifications → Discord and paste the URL
4

Configure Events

Select which events should trigger Discord notifications
5

Test

Click Send Test to verify the webhook works

​
Message Format

Discord notifications include:
FieldDescription
TitleEvent type (e.g., “Recording Started”)
ChannelStreamer name
PlatformTwitch/YouTube/Kick icon
Stream TitleCurrent stream title
CategoryGame or category
QualityRecording quality
ThumbnailStream thumbnail image

​
Customization

Customize Discord messages in Settings → Notifications → Discord → Format:
OptionDescription
Include ThumbnailAttach stream thumbnail
Include LinkAdd link to stream
Mention Role@mention a role for certain events
ColorEmbed color by event type

​
Telegram

Send notifications to a Telegram chat or channel.

​
Setup

1

Create Bot

Message @BotFather and create a new bot
2

Get Token

Copy the bot token provided by BotFather
3

Get Chat ID

Add the bot to your channel/group, then use @userinfobot to get the chat ID
4

Configure

Navigate to Settings → Notifications → Telegram and enter token + chat ID
5

Test

Click Send Test to verify the bot works

​
Message Format

Telegram notifications include:
  • Event type emoji
  • Channel name and platform
  • Stream title
  • Recording details
  • Thumbnail (optional)

​
Bot Commands

Your Telegram bot responds to commands:
CommandDescription
/statusShow active recordings
/channelsList monitored channels
/storageShow storage usage
/pause {channel}Pause recording
/resume {channel}Resume recording
Enable commands in Settings → Notifications → Telegram → Enable Commands.

​
Generic Webhooks

Send notifications to any HTTP endpoint.

​
Setup

1

Add Webhook

Navigate to Settings → Notifications → Webhooks → Add Webhook
2

Configure Endpoint

Enter the URL and authentication method
3

Select Events

Choose which events trigger the webhook
4

Test

Click Send Test to verify the endpoint

​
Request Format

Webhooks send POST requests with JSON body: 
{
	"event": "recording.started",
	"timestamp": "2026-02-02T14:30:00Z",
	"data": {
		"channel": "shroud",
		"platform": "twitch",
		"title": "Valorant Ranked",
		"category": "Valorant",
		"quality": "1080p60",
		"recording_id": "abc123"
	}
}

​
Authentication

MethodDescription
NoneNo authentication
Bearer TokenAuthorization header with token
Basic AuthUsername/password
Custom HeaderAny custom header

​
Retry Policy

Failed webhooks are retried:
  • 3 attempts with exponential backoff
  • Delays: 1s, 5s, 30s
  • Failed webhooks logged to console

​
Push Notifications (Desktop)

Desktop application supports system notifications:

​
Windows

Uses Windows Toast notifications. Appears in Action Center.

​
Linux

Uses system notification daemon (libnotify).

​
Configuration

SettingDescription
EnableToggle push notifications
SoundPlay notification sound
EventsWhich events trigger push

​
Email Notifications

Email notifications require SMTP configuration.
1

Configure SMTP

Navigate to Settings → Notifications → Email and enter: - SMTP server and port - Username and password - From address
2

Add Recipients

Enter email addresses to receive notifications
3

Select Events

Choose which events send emails

​
Notification Filters

Control notification volume:

​
Per-Channel Settings

1

Go to Channels

Select a channel
2

Notification Settings

Toggle which notifications this channel triggers

​
Quiet Hours

Suppress notifications during specific hours:
SettingDescription
StartWhen quiet hours begin
EndWhen quiet hours end
ExceptionsEvents that ignore quiet hours

​
Rate Limiting

Prevent notification spam:
SettingDescription
CooldownMinimum time between notifications
BatchGroup notifications within a time window

​
Testing

Test your notification configuration:
1

Go to Settings

Navigate to Settings → Notifications
2

Select Service

Click Send Test on any configured service
3

Verify

Check that the test notification arrived