website·Indexed 32 days ago
https://docs.fossabot.comDocumentation for Fossabot, a Twitch moderation and automation bot. Includes guides on getting started, using keywords, managing nukes, and a comprehensive list of dynamic variables for inline text replacement, such as $(user), $(game), $(sender), and integration with external APIs like YouTube, X, and last.fm.
customapi request is triggered by a chat message, Fossabot includes additional headers containing information about the user who sent the message.| Header | Description |
|---|---|
x-fossabot-message-id | Message ID from the provider (e.g., Twitch) |
x-fossabot-message-userlogin | Lowercase sender username |
x-fossabot-message-userdisplayname | Uppercase/internationalized sender username |
x-fossabot-message-userprovider | Platform the message was sent from |
x-fossabot-message-userproviderid | Platform ID of the sender |
The $(user) variable and its members provide metadata about a Twitch user's channel. All $(user) variables take one optional parameter: a Twitch username. If no username is provided or hardcoded, it defaults to the sender of the command.
Important Note for Timers: When used inside a timer, a valid Twitch username MUST be provided as the first parameter, otherwise the variable will return nothing because timers are executed by the bot rather than a specific user.
// Example: Shoutout command
Shout out to $(user.display_name)! Go follow them at twitch.tv/$(user.login) - they were last seen playing $(user.game)!
// Example: Hardcoding a user (e.g., fossabot)
Shout out to $(user.display_name fossabot)! Go follow them at twitch.tv/$(user.login fossabot)!The $(tiktok) and $(tiktok.video) variables return metadata about a broadcaster's latest TikTok video. For these variables to work, the broadcaster must first authorize and connect their TikTok account via the Integrations tab on the Fossabot dashboard.
Both variables support one optional parameter for custom formatting using the following placeholders:
{title}: The video's title{description}: The video's description{url}: The video's URL{created}: The video's creation date{duration}: The video's length{like_count}: Number of likes{comment_count}: Number of comments{share_count}: Number of shares{view_count}: Number of views{id}: The video's unique identifierIf no TikTok account is connected, the variable returns: [Error: TikTok authorization invalid. Please authorize on fossabot.com -> integrations]
// Default output (Title - URL)
$(tiktok)
// Custom formatted output
$(tiktok '{title}' currently has {view_count} views, {share_count} shares and {like_count} likes.)context_url to retrieve detailed information about the channel and the message that triggered the request. If the request was triggered by an automated action (like a timer), the message field will be null.GET https://api.fossabot.com/v2/customapi/context/<token>Example Response (200 OK):
{
"channel": {
"id": "1",
"login": "aiden",
"display_name": "Aiden",
"provider": "twitch",
"provider_id": "87763385"
// ... other channel fields
},
"message": {
"id": "ae9a4e3e-d495-4d75-aec6-8965e7c4ccd0",
"content": "!testcommand",
"user": {
"provider_id": "87763385",
"login": "aiden",
"roles": [ { "id": "1", "name": "Broadcaster", "type": "broadcaster" } ]
}
}
}$(sender) variable family provides various metadata about the user who sent a message. These variables cannot be used inside Timers because Timers are executed by Fossabot on an interval rather than in response to a specific user message. Using these variables in a timer will result in the error: [Error: Cannot be executed inside of a timer].$(sender.uptime) and $(sender.viewers) will return [Error: Stream is offline.] if the sender is not currently live.$(sender.game) // Current directory (e.g., Just Chatting)
$(sender.title) // Current stream title
$(sender.uptime) // Time since going live (e.g., 3 hours and 25 minutes)
$(sender.viewers) // Current viewer count
$(sender.views) // Total profile views
$(sender.followers)// Total follower count$(leagueoflegends) variable returns the current league points (LP) and rank of a League of Legends player. It requires two parameters: the account region and the player's Riot ID (formatted as Name#Tag). While legacy Summoner Names are currently supported, Riot IDs are the required standard.$(leagueoflegends <region> <Riot#ID>)
Example: $(leagueoflegends kr Hide on bush#KR1)
Output: Hide on bush is currently Grandmaster I 789 LPAfter a nuke is executed, Fossabot sends a whisper containing a link to a detailed report and the channel name. This report page allows you to: