Everything you need to
master Vivy.
Complete guides, command references, dashboard walkthroughs, API documentation, and troubleshooting. Find answers instantly.
Quick Start Guide
Get Vivy up and running in your Discord server in under 5 minutes.
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.
?.Step 1: Invite Vivy
Inviting Vivy
How to invite Vivy to your Discord server and what permissions it needs.
Invite Link
https://discord.com/oauth2/authorize?client_id=1481773011668434975&permissions=8&scope=bot%20applications.commands
Required Permissions
Permissions Guide
Which permissions Vivy needs and why each one matters.
Permission Reference
| Permission | Required For | Level |
|---|---|---|
BAN_MEMBERS | ?ban, ?banforlife, ?unban | Required |
KICK_MEMBERS | ?kick | Required |
MODERATE_MEMBERS | ?timeout, ?untimeout | Required |
MANAGE_MESSAGES | ?clear, automod deletion | Required |
MANAGE_ROLES | ?autorole, ?temprole, ?jail, ?mute | Required |
MANAGE_CHANNELS | ?hide, ?unhide, voice rooms | Required |
VIEW_AUDIT_LOG | Logging, moderation tracking | Required |
SEND_MESSAGES | All bot responses | Required |
EMBED_LINKS | Rich embeds, rank cards | Required |
ATTACH_FILES | Rank cards, welcome images | Required |
CONNECT | Voice rooms feature | Recommended |
Logging In
How to authenticate using Discord OAuth2 to access the web dashboard.
Authentication Flow
identify and guilds scopes, allowing the dashboard to verify your identity and servers list.Basic Configuration
Recommended configurations for newly added guilds.
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 Overview
Manage all 20 dashboard setups directly from your browser.
The Vivy Web Dashboard consists of 20 modular tabs. Select your server to load configuration options immediately.
| Module Name | Settings Managed |
|---|---|
| Overview | Server stats, member count, fast actions |
| Welcome Messages | Join cards, direct message logs |
| Auto Role | Apply default roles to joining users |
| Security & Prefix | Custom command prefix, anti-bot, anti-webhook |
| Anti-Link Shield | Enable domain block lists and whitelist roles |
| Auto Moderation | Caps filters, emojis spam filters, repeat text spam |
| Warnings Setup | Warning role, warning thresholds and temp mutes |
| Mute Setup | Set muted role and mute logs channel |
| Jail Setup | Isolation role and appeal channel routing |
| Server Logs | Event logger routing for messages, members, voice |
| Audit Logs | Interactive search of all moderator database logs |
| Verification System | Custom male/female/unverified roles for verify gates |
| Apply Panel | modal application setups and results logs |
| Economy Setup | Coins multipliers, shop items, tax rate config |
| Leveling Setup | XP gain rates, role rewards, rank background image |
| Giveaways | Deploy giveaways, winner count, whitelist filters |
| Need Help Rooms | Voice support join-to-create channels setup |
| Custom Commands | Create customized text replies and aliases |
| Developer API Keys | Generate secure API keys to integrate REST API data |
| Premium Plan | Unlock custom premium features |
Welcome Messages
Configure custom join, leave, and direct message welcome logs.
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.
Auto Role
Automatically assign roles to new members on server join.
Ensure new members receive default roles immediately on join (e.g. "Member"). You can also configure separate roles for bot accounts.
Security & Prefix
Command prefixes, Security Owners Roles, Anti-Bot and Anti-Webhook defenses.
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.
Anti-Link Shield
Delete unauthorized Discord invites and external URL links instantly.
Whitelist & Filters
Enable the Link Filter shield to delete link messages. You can configure whitelisted roles that bypass this shield, as well as whitelisted domains (e.g. youtube.com, spotify.com).
Auto Moderation
Automatically moderate spam, caps, mass mentions, and raids.
Filters Configuration
Set limits for caps percentage, repeat messages (spam), emoji spam, and mass mentions. Configure punishments like deletion, warning, or automatic temp-mutes.
Warnings Setup
Configure warnings role, warning logs, and escalation actions.
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).
Mute Setup
Configure muted roles and logging for muted users.
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.
Jail Setup
Configure isolation roles and isolation jail channels.
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.
Server Logs
Route specific server event logs to dedicated channels.
Channel Routing
You can route specific events to dedicated channels:
| Log Type | Events Tracked |
|---|---|
| Message Logs | Edits, deletions, bulk message purge |
| Member Logs | Joins, leaves, role updates, nickname changes |
| Voice Logs | Voice channel joins, leaves, moves, server mutes/deafens |
| Moderation Logs | Bans, kicks, mutes, warnings, jail isolation |
Audit Logs
Interactive logs search of all moderation actions executed by staff and AutoMod.
Browse all past warnings, mutes, timeouts, bans, kicks, and jails. Filter entries by action type, moderator name, or targeted user.
Verification System
Staff-approved member verification gate with customizable roles.
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.
Apply Panel
Build custom staff application forms with modals and review logs.
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.
Economy Setup
Virtual coins, daily rewards, server shop items, and custom tax rates.
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.
Leveling Setup
Configure message XP multipliers, level-up roles, and level boosters.
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).
Giveaways
Deploy giveaways with winner count settings and whitelist rules.
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.
Need Help Rooms
Configure voice channels where members join to generate private help sessions.
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.
Custom Commands
Create server-specific commands with custom text replies.
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.
Developer API Keys
Generate API keys to communicate programmatically with your guild's data.
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.
Premium Plan
Activate premium services and personal voice channels for your guild.
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.
Moderation Commands
Complete reference for all moderation actions, syntax, and permission requirements.
Security Commands
Lockdown, link filters, and bot defense command references.
Utility Commands
Check stats, configurations, roles, and configure guilds.
Leveling Commands
View rank card, XP leaderboards, and modify XP levels.
Economy Commands
Reference for coins balance, transfers, and daily claims.
Voice Commands
Voice channel user controls, voice stats, and voice moderation.
Fun Commands
Lighthearted command reference for reactions, rolls, and compatibility.
Marriage Commands
Propose, divorce, and check marriage statistics inside your guild.
Giveaways Commands
Commands reference for launching giveaways and ban list entries.
Developer Portal
API key management, developer tools, and analytics dashboards.
/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.
REST API
REST endpoints overview for fetching levels, log files, and warnings.
Base Endpoint
https://yourdomain.com/api/v1
HTTP Headers Authorization
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Available Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /guilds/{id} | Retrieve server configuration and stats |
| POST | /guilds/{id}/ban | Ban a user |
| POST | /guilds/{id}/warn | Warn a user |
| GET | /guilds/{id}/levels | Get XP leaderboard |
| PATCH | /guilds/{id}/levels/{userId} | Update XP values |
| GET | /guilds/{id}/economy | Get coin leaderboard |
| GET | /guilds/{id}/logs | Get logs routing config |
Authentication
Scopes and rules for API keys authorization.
API keys generated under Developer API Keys dashboard tab scopes restrict capabilities to specific database actions:
| Scope | Permissions granted |
|---|---|
read:guild | Read guild setups and counts |
write:moderation | Execute kicks, warnings, bans |
write:levels | Modify leveling XP |
write:economy | Modify coin balances |
read:logs | View warning histories and logs |
Webhooks
Receive instant HTTP POST callbacks for key server events.
Configure webhook URLs to receive JSON payloads whenever the following events execute:
| Webhook Event | Trigger Context |
|---|---|
member.ban | Guild ban executed |
member.kick | Guild kick executed |
member.warn | Warning created in database |
member.join | User joined guild |
level.up | User level increased |
automod.action | Automod deletion executed |
Rate Limits
Overview of API request limits per token.
| Endpoint Category | Max Requests | Reset Duration |
|---|---|---|
| OAuth endpoints | 20 requests | 15 min |
| REST General | 200 requests | 5 min |
| Developer API Keys | 100 requests | 5 min |
Frequently Asked Questions
Answers to the most common questions regarding Vivy Discord integrations.
?. You can change this or add extra prefixes by running ?addprefix [prefix] or visiting Security & Prefix in the web dashboard.?), (3) the bot has Send Messages and View Channel permissions. You can also mention @Vivy help.Troubleshooting
Quick fixes for common bot and dashboard configuration errors.
Bot offline or silent
@Vivy help. If it replies, the prefix has been customized. Check prefix configurations.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 Code | Potential Cause | Resolution |
|---|---|---|
| 403 Forbidden | Role hierarchy blocks command | Move Vivy role higher in settings |
| 401 Unauthorized | Session token expired | Refresh dashboard login session |
| 429 Rate Limit | API limit exceeded | Wait for resets |
Changelog
History of all updates and fixes for the Vivy bot platform.