Vivy logo Vivy Docs
⌘K
Documentation

Everything you need to
master Vivy.

Complete guides, command references, dashboard walkthroughs, API documentation, and troubleshooting. Find answers instantly.

🚀
Getting Started
Invite, configure, and go live in minutes
🎛️
Dashboard
Configure every feature from your browser
⚙️
Bot Commands
Full command reference with examples
🛡️
AutoMod
Smart spam and safety automation
📈
Leveling
XP, rank cards, and leaderboards
💰
Economy
Coins, balances, and server economy
🎁
Giveaways
Create and manage server giveaways
🎙️
Voice Rooms
Private dynamic support channels
📋
Logging
Track every action in your server
💍
Marriage
Server marriage system
👨‍💻
Developers
REST API, webhooks, and API keys
FAQ
Answers to the most common questions
🔧
Troubleshooting
Diagnose and fix common issues
📝
Changelog
Latest updates and improvements
Getting Started

Quick Start Guide

Get Vivy up and running in your Discord server in under 5 minutes.

5 min read Updated July 2026

Overview

Vivy is an all-in-one Discord bot offering moderation, leveling, economy, giveaways, voice rooms, auto-moderation, verification, applications, and more — all configurable through a web dashboard.

No coding required! Everything is managed through the dashboard. The default command prefix is ?.

Step 1: Invite Vivy

1
Visit the website
Go to the Vivy website and click Add to Discord.
2
Select your server
Choose the server from the dropdown. You must have Manage Server permission.
3
Authorize permissions
Review and approve the requested permissions, then click Authorize.
4
Login to Dashboard
Open the dashboard at /auth/discord/login, select your server, and start configuring.
Getting Started

Inviting Vivy

How to invite Vivy to your Discord server and what permissions it needs.

3 min read
URL
https://discord.com/oauth2/authorize?client_id=1481773011668434975&permissions=8&scope=bot%20applications.commands

Required Permissions

Administrator (recommended)
Manage Channels
Manage Roles
Manage Messages
Ban Members
Kick Members
Moderate Members
Send Messages
Embed Links
Read Message History
View Audit Log
Connect (Voice)
Role Hierarchy: Vivy's role must be placed above any role it needs to manage in Server Settings → Roles.
Getting Started

Permissions Guide

Which permissions Vivy needs and why each one matters.

4 min read

Permission Reference

PermissionRequired ForLevel
BAN_MEMBERS?ban, ?banforlife, ?unbanRequired
KICK_MEMBERS?kickRequired
MODERATE_MEMBERS?timeout, ?untimeoutRequired
MANAGE_MESSAGES?clear, automod deletionRequired
MANAGE_ROLES?autorole, ?temprole, ?jail, ?muteRequired
MANAGE_CHANNELS?hide, ?unhide, voice roomsRequired
VIEW_AUDIT_LOGLogging, moderation trackingRequired
SEND_MESSAGESAll bot responsesRequired
EMBED_LINKSRich embeds, rank cardsRequired
ATTACH_FILESRank cards, welcome imagesRequired
CONNECTVoice rooms featureRecommended
Pro Tip: Grant Vivy Administrator permissions and place its role near the top of your role list for maximum functionality.
Getting Started

Logging In

How to authenticate using Discord OAuth2 to access the web dashboard.

2 min read

Authentication Flow

1
Click Login
Click the Open Dashboard or Login button on the website.
2
Redirect to Discord
You will be redirected to Discord's official authorization page.
3
Approve scopes
Approve the identify and guilds scopes, allowing the dashboard to verify your identity and servers list.
4
Server list
You are redirected back to the dashboard server list to pick your guild.
Getting Started

Basic Configuration

Recommended configurations for newly added guilds.

4 min read

First Steps

  • Prefix: Ensure your prefix matches your preferred style. The default prefix is ?.
  • Logs Setup: Route moderation and message updates to logs channels under Server Logs dashboard tab.
  • Admin Safeguards: Set up your Security Owner Role under Security & Prefix tab to secure configurations.
Dashboard

Dashboard Overview

Manage all 20 dashboard setups directly from your browser.

5 min read

The Vivy Web Dashboard consists of 20 modular tabs. Select your server to load configuration options immediately.

Module NameSettings Managed
OverviewServer stats, member count, fast actions
Welcome MessagesJoin cards, direct message logs
Auto RoleApply default roles to joining users
Security & PrefixCustom command prefix, anti-bot, anti-webhook
Anti-Link ShieldEnable domain block lists and whitelist roles
Auto ModerationCaps filters, emojis spam filters, repeat text spam
Warnings SetupWarning role, warning thresholds and temp mutes
Mute SetupSet muted role and mute logs channel
Jail SetupIsolation role and appeal channel routing
Server LogsEvent logger routing for messages, members, voice
Audit LogsInteractive search of all moderator database logs
Verification SystemCustom male/female/unverified roles for verify gates
Apply Panel modal application setups and results logs
Economy SetupCoins multipliers, shop items, tax rate config
Leveling SetupXP gain rates, role rewards, rank background image
GiveawaysDeploy giveaways, winner count, whitelist filters
Need Help RoomsVoice support join-to-create channels setup
Custom CommandsCreate customized text replies and aliases
Developer API KeysGenerate secure API keys to integrate REST API data
Premium PlanUnlock custom premium features
Dashboard

Welcome Messages

Configure custom join, leave, and direct message welcome logs.

4 min read

Configuration

  • Channel Routing: Choose where welcome embeds are sent.
  • Canvas Join Card: Upload custom canvas background image. Vivy paints the user avatar, nickname, and server join count dynamically on the card.
  • DM Welcome: Send direct message alerts to newly joining members.
Dashboard

Auto Role

Automatically assign roles to new members on server join.

3 min read

Ensure new members receive default roles immediately on join (e.g. "Member"). You can also configure separate roles for bot accounts.

Dashboard

Security & Prefix

Command prefixes, Security Owners Roles, Anti-Bot and Anti-Webhook defenses.

4 min read

Prefix Configuration

Modify your bot's text command prefix (default: ?). You can also set a backup prefix.

Security Owner Roles

Designate a specific role as the Security Owner. Only server administrators or members with this role can run sensitive protection toggles.

Defense Shields

  • Anti-Bot: Automatically kick or ban newly joining unverified bot accounts.
  • Anti-Webhook: Automatically destroy newly created webhooks to prevent token-leaks spam.
Dashboard

Auto Moderation

Automatically moderate spam, caps, mass mentions, and raids.

5 min read

Filters Configuration

Set limits for caps percentage, repeat messages (spam), emoji spam, and mass mentions. Configure punishments like deletion, warning, or automatic temp-mutes.

Dashboard

Warnings Setup

Configure warnings role, warning logs, and escalation actions.

3 min read

Set a role to assign to warned members, select a log channel, and create escalation thresholds (e.g. 3 warnings = temp mute, 5 warnings = server kick, 7 warnings = perm ban).

Dashboard

Mute Setup

Configure muted roles and logging for muted users.

3 min read

Select the muted role assigned during a mute command. Ensure the role has Send Messages permissions denied in all channels. Logs are routed to the specified mute logs channel.

Dashboard

Jail Setup

Configure isolation roles and isolation jail channels.

3 min read

Assign the jail role and set the default jail channel. While jailed, members lose all regular roles and can only view and type in the jail channel to submit appeals.

Dashboard

Server Logs

Route specific server event logs to dedicated channels.

4 min read

Channel Routing

You can route specific events to dedicated channels:

Log TypeEvents Tracked
Message LogsEdits, deletions, bulk message purge
Member LogsJoins, leaves, role updates, nickname changes
Voice LogsVoice channel joins, leaves, moves, server mutes/deafens
Moderation LogsBans, kicks, mutes, warnings, jail isolation
Dashboard

Audit Logs

Interactive logs search of all moderation actions executed by staff and AutoMod.

3 min read

Browse all past warnings, mutes, timeouts, bans, kicks, and jails. Filter entries by action type, moderator name, or targeted user.

Dashboard

Verification System

Staff-approved member verification gate with customizable roles.

4 min read

Roles Setup

Manage verification gate setup by configuring roles:

  • Verificator Role: Staff allowed to approve member verification appeals.
  • Unverified Role: Applied automatically on join to lock out general channels.
  • Verified Role (Male/Default): Normal verified member role assigned on approval.
  • Verified Female Role: Separate verified role available for female members.
  • Verification Logs Channel: Channel routing verification events.
Dashboard

Apply Panel

Build custom staff application forms with modals and review logs.

4 min read

Post custom application panels in channels. Users click Apply, answer questions in a Discord modal, and their application is routed to review channels where staff can accept or decline with a button.

Dashboard

Economy Setup

Virtual coins, daily rewards, server shop items, and custom tax rates.

4 min read

Configure server coin multipliers, daily coin rewards, and transaction tax rates (e.g. 5% coin tax on transfers). Set up items in the Server Shop that users buy using their virtual balance.

Dashboard

Leveling Setup

Configure message XP multipliers, level-up roles, and level boosters.

5 min read

XP Modifiers

Adjust the XP gained per message and configuration of XP cooldown timers. Configure specific roles as Level Boosters to receive custom XP multipliers (e.g. 1.5x XP).

Level Up Rewards

Create automatic role rewards assigned to users once they reach specific levels (e.g. level 10 grants "Veteran" role).

Dashboard

Giveaways

Deploy giveaways with winner count settings and whitelist rules.

3 min read

Create, monitor, and cancel server giveaways from the dashboard. Whitelist specific roles to permit entries or set blacklisted members (using the ?vb command) to forbid entries.

Dashboard

Need Help Rooms

Configure voice channels where members join to generate private help sessions.

4 min read

Configure a "Join-to-Create" voice channel. When a member joins, Vivy automatically creates a private voice channel under the designated category. The channel is auto-deleted once empty.

Settings

  • Join Voice Channel: Trigger voice channel.
  • Room Category: Directory category where voice rooms spawn.
  • System Logs Channel: Logs channel for session creations and joins.
  • Staff Role: Role allowed to join and moderate help channels.
  • Manager Role: Notified in logs when channels are generated.
Dashboard

Custom Commands

Create server-specific commands with custom text replies.

3 min read

Create text triggers and responses. When a member invokes the trigger (e.g. ?ip), the bot sends the custom response text. Perfect for providing quick links, rules, and server FAQs.

Dashboard

Developer API Keys

Generate API keys to communicate programmatically with your guild's data.

3 min read

Generate, scope, and revoke secure API keys. Keys permit REST API access (e.g. reading logs, warning tables, or leveling statistics) on behalf of your guild.

Keep API keys secret. Anyone with access to the key can access server data and perform moderation actions.
Premium

Premium Plan

Activate premium services and personal voice channels for your guild.

4 min read

Premium Perks

Enabling Premium activates advanced commands allowing users to spin up personal premium voice rooms. Premium rooms can be renamed, customized with emoji icons, assigned custom colors, and whitelist specific users.

Commands

Moderation Commands

Complete reference for all moderation actions, syntax, and permission requirements.

6 min read
?ban
Permanently ban a member from the server.
?ban <user> [reason]
Ban Members
?banforlife
Ban a member permanently and record it in the lifetime database.
?banforlife <user> [reason]
Ban Members
?unban
Unban a member by ID.
?unban <userId> [reason]
Ban Members
?unbanforlife
Unban a member from the lifetime database.
?unbanforlife <userId>
Ban Members
?kick
Kick a member from the server.
?kick <user> [reason]
Kick Members
?mute
Assign the mute role to a member.
?mute <user> [duration] [reason]
Manage Roles
?unmute
Remove the mute role from a member.
?unmute <user>
Manage Roles
?timeout
Discord-native timeout. Expires automatically.
?timeout <user> <duration> [reason]
Moderate Members
?untimeout
Manually remove timeout early from a member.
?untimeout <user>
Moderate Members
?warn
Issue a warning stored in the database.
?warn <user> <reason>
Manage Messages
?warnlist
Display warnings log for a user.
?warnlist <user>
Manage Messages
?unwarn
Remove a warning by its warning ID.
?unwarn <user> <warnId>
Manage Messages
?jail
Jail a member (isolates channel view).
?jail <user> [reason]
Manage Roles
?unjail
Release jailed member and restore roles.
?unjail <user>
Manage Roles
?clear
Delete a specified amount of messages in channel.
?clear <amount> [user]
Manage Messages
?nick
Modify a user nickname.
?nick <user> [nickname]
Manage Nicknames
?temprole
Assign a role temporarily for a set duration.
?temprole <user> <role> <duration>
Manage Roles
?hide
Hide a channel from regular members.
?hide [channel]
Manage Channels
?unhide
Restore a hidden channel's visibility.
?unhide [channel]
Manage Channels
Commands

Security Commands

Lockdown, link filters, and bot defense command references.

4 min read
?lock
Lock down a channel. Regular members lose Send Messages rights.
?lock [channel]
Manage Channels
?unlock
Unlock a channel to restore normal posting permissions.
?unlock [channel]
Manage Channels
?antilink
Turn the anti-link link filter on or off.
?antilink <on|off>
Manage Guild
?antilink-whitelist
Add or remove a domain from the whitelist.
?antilink-whitelist <add|remove> <domain>
Manage Guild
?antilink-stats
Show anti-link whitelist configuration and statistics.
?antilink-stats
Manage Guild
?antibots
Manage action on newly joining unapproved bots.
?antibots <on|off|kick|ban>
Manage Guild
?antiwebhook
Enable or disable anti-webhook defense.
?antiwebhook <on|off>
Manage Guild
?v-blacklist
Blacklist a member from entering any server voice channels.
?v-blacklist <add|remove|list> [user]
Manage Guild
Commands

Utility Commands

Check stats, configurations, roles, and configure guilds.

5 min read
?help
Display help command index.
?help [command]
?ping
Check bot latency and API gateway latency.
?ping
?user-info
View info about a member (joined dates, roles, ID).
?user-info [user]
?server-info
Show statistics for the server.
?server-info
?avatar
Get user avatar link.
?avatar [user]
?banner
Get user profile banner link.
?banner [user]
?role-info
Get role properties and user counts.
?role-info <role>
?channel-info
Get channel information.
?channel-info [channel]
?emoji-info
Get details about a custom server emoji.
?emoji-info <emoji>
?addemoji
Upload a new custom emoji.
?addemoji <name> [url]
Manage Emojis
?invites
Show count of verified invites by a user.
?invites [user]
?topinvites
Show top server inviters leaderboard.
?topinvites
?boosters
List all current server nitro boosters.
?boosters
?membercount
Show total count of users and bots in the server.
?membercount
?inrole
List all members possessing a specific role.
?inrole <role>
?embed
Construct and post a formatted rich embed.
?embed <title> | <description> | [color]
Manage Messages
?autorole
Add or remove roles from Auto Role join system.
?autorole <add|remove|list> [role]
Manage Roles
?addprefix
Register a new prefix.
?addprefix <prefix>
Manage Guild
?firstmessage
Generate URL to first message inside channel.
?firstmessage [channel]
Commands

Leveling Commands

View rank card, XP leaderboards, and modify XP levels.

3 min read
?rank
Generates card showing current level and XP.
?rank [user]
?leaderboard
List the top ranked server members.
?leaderboard [page]
?leveladmin
Set or add XP or level of a user.
?leveladmin <set|add|reset> <user> [amount]
Manage Guild
Commands

Economy Commands

Reference for coins balance, transfers, and daily claims.

3 min read
?bal
Check coin balance for yourself or another member.
?bal [user]
?daily
Claim daily coin reward.
?daily
24h Cooldown
?transfer
Transfer coins to another user.
?transfer <user> <amount>
?top
Richest members ranking page.
?top [page]
Commands

Voice Commands

Voice channel user controls, voice stats, and voice moderation.

4 min read
?vmute
Server-mute a member in voice.
?vmute <user> [reason]
Mute Members
?vunmute
Server-unmute a member in voice.
?vunmute <user>
Mute Members
?vdeafen
Server-deafen a member in voice.
?vdeafen <user> [reason]
Deafen Members
?vundeafen
Server-undeafen a member in voice.
?vundeafen <user>
Deafen Members
?vkick
Disconnect a member from their current voice channel.
?vkick <user> [reason]
Move Members
?move
Move a member to a different voice channel.
?move <user> <channel>
Move Members
?vclist
List all members in server voice channels.
?vclist
?stats-voice
View total voice minutes activity stats.
?stats-voice [user]
?find
Locate the voice channel of a member.
?find <user>
?join
Join the same voice channel as another member.
?join <user>
Move Members
Commands

Fun Commands

Lighthearted command reference for reactions, rolls, and compatibility.

3 min read
?hug
Hug a member.
?hug <user>
?kiss
Kiss a member.
?kiss <user>
?slap
Slap a member.
?slap <user>
?dance
Perform a dance move.
?dance
?smile
Smile.
?smile
?love
Measure compatibility with another member.
?love <user1> [user2]
?howgay
Measure how gay a member is.
?howgay [user]
?gender
Check user gender.
?gender [user]
?cringe
Rates a member's cringe level.
?cringe [user]
?roll
Roll a dice.
?roll [sides]
?cat
Generate a cute cat image.
?cat
Commands

Marriage Commands

Propose, divorce, and check marriage statistics inside your guild.

3 min read
?marriage
Propose marriage to a server member. Requires target to accept.
?marriage <user>
?divorce
Divorce your current partner.
?divorce
?marriage-stats
View details of a member's marriage state.
?marriage-stats [user]
Commands

Giveaways Commands

Commands reference for launching giveaways and ban list entries.

3 min read
?vg
Launch a giveaway (e.g. ?vg 1d 2 Discord Nitro).
?vg <duration> <winners> <prize>
Manage Guild
?vb
Blacklist a user from joining future giveaways.
?vb <user> [reason]
Manage Guild
Commands

Premium Rooms Commands

Create and manage customized personal premium voice rooms.

4 min read
Requires an active server Premium activation to run pcreate commands.
?pcreate
Generate your premium voice room channel.
?pcreate <name>
?pdelete
Destroy your premium voice room channel.
?pdelete
?pname
Rename your personal voice channel.
?pname <name>
?picon
Add a custom emoji icon prefix to your room.
?picon <emoji>
?pcolor
Configure color formatting of your custom room role.
?pcolor <hex_color>
?padd
Add a member permissions to view/join your room.
?padd <user>
?premove
Remove member permissions from your room.
?premove <user>
?pmadd
Make a member a room manager.
?pmadd <user>
?pmremove
Revoke room manager status from a member.
?pmremove <user>
?plist
List all permitted room users.
?plist
?pshowall
List all active premium voice rooms.
?pshowall
Manage Guild
Developer

Developer Portal

API key management, developer tools, and analytics dashboards.

4 min read
The portal is accessible at /developer for authorized developers. Ask staff to grant you Developer roles.

Features

  • Generate and delete API keys.
  • Monitor REST API requests rates and limit resets.
  • Inspect detailed usage charts.
Developer

REST API

REST endpoints overview for fetching levels, log files, and warnings.

8 min read

Base Endpoint

URL
https://yourdomain.com/api/v1

HTTP Headers Authorization

Headers
Authorization: Bearer YOUR_API_KEY
Content-Type:  application/json

Available Endpoints

MethodPathDescription
GET/guilds/{id}Retrieve server configuration and stats
POST/guilds/{id}/banBan a user
POST/guilds/{id}/warnWarn a user
GET/guilds/{id}/levelsGet XP leaderboard
PATCH/guilds/{id}/levels/{userId}Update XP values
GET/guilds/{id}/economyGet coin leaderboard
GET/guilds/{id}/logsGet logs routing config
Developer

Authentication

Scopes and rules for API keys authorization.

4 min read

API keys generated under Developer API Keys dashboard tab scopes restrict capabilities to specific database actions:

ScopePermissions granted
read:guildRead guild setups and counts
write:moderationExecute kicks, warnings, bans
write:levelsModify leveling XP
write:economyModify coin balances
read:logsView warning histories and logs
Developer

Webhooks

Receive instant HTTP POST callbacks for key server events.

5 min read

Configure webhook URLs to receive JSON payloads whenever the following events execute:

Webhook EventTrigger Context
member.banGuild ban executed
member.kickGuild kick executed
member.warnWarning created in database
member.joinUser joined guild
level.upUser level increased
automod.actionAutomod deletion executed
Developer

Rate Limits

Overview of API request limits per token.

3 min read
Endpoint CategoryMax RequestsReset Duration
OAuth endpoints20 requests15 min
REST General200 requests5 min
Developer API Keys100 requests5 min
Support

Frequently Asked Questions

Answers to the most common questions regarding Vivy Discord integrations.

5 min read
How do I invite Vivy to my guild?
Visit the main page, click Add to Discord, choose your guild and authorize the permissions. Ensure you hold Manage Server rights.
What is the default command prefix?
The default prefix is ?. You can change this or add extra prefixes by running ?addprefix [prefix] or visiting Security & Prefix in the web dashboard.
Why doesn't my guild show in dashboard?
You must have Manage Server permissions on the target server and the bot must be invited. Log out and back in to refresh OAuth lists.
Bot does not respond to commands.
Verify: (1) Vivy is online in member list, (2) you are using correct prefix (default: ?), (3) the bot has Send Messages and View Channel permissions. You can also mention @Vivy help.
Why can't the bot warn or mute a member?
Discord role hierarchies apply. Vivy's highest role must be placed higher than any member's role it tries to moderate. Vivy cannot moderate the server owner.
Dashboard says the bot is offline.
The bot may be undergoing minor updates or service restarts. If offline longer than 15 minutes, check the support channels.
Is my server data secure?
Yes. We only store settings, coins balances, warnings, and XP records needed to operate the bot. Client-dashboard authentication is secured via Discord OAuth.
Support

Troubleshooting

Quick fixes for common bot and dashboard configuration errors.

6 min read

Bot offline or silent

1
Check status indicator
Confirm bot is online in server member list.
2
Try direct mentions
Invoke @Vivy help. If it replies, the prefix has been customized. Check prefix configurations.
3
Examine Channel Permissions Override
Confirm Vivy has permissions: View Channel, Send Messages, and Read Message History.

Dashboard login errors

  • Try logging out and back in to clear OAuth sessions.
  • Enable browser cookie support (disabled cookies block OAuth handshakes).
  • Disable private browsing or VPN filters if they block authorization tokens.

Response Errors

Status CodePotential CauseResolution
403 ForbiddenRole hierarchy blocks commandMove Vivy role higher in settings
401 UnauthorizedSession token expiredRefresh dashboard login session
429 Rate LimitAPI limit exceededWait for resets
Changelog

Changelog

History of all updates and fixes for the Vivy bot platform.

Latest: July 2026
v3.5.0
July 4, 2026
feat Documentation center at /docs with instant search filters
feat Custom bot prefix options with multiple characters support
feat Marriage commands added: ?marriage, ?divorce, ?marriage-stats
feat Premium voice rooms commands added: ?pcreate, ?pname, ?pcolor etc.
improve Web dashboard tab integration with live database updates
fix Leveling XP multiplier booster bug
security Enhanced secure cookies headers in REST API sessions
v3.0.0
January 15, 2026
feat Fully rewritten dashboard layout containing 20 modules
feat Member Verification Button system
feat Anti-Bot & Anti-Webhook protection shields
On this page