Discord Bot How-To

The Clavata Discord Bot - ClavataBot, can help you moderate your Discord communities. Big or small, the bot offers a number of moderation features and abilities to moderate various channels. It works seamlessly with your existing Clavata policies or create a new one just for Discord. Read on to learn how to set the bot up and what the different commands do.

Setting up your Discord bot

Setting up the Discord bot is quick and easy and only take a few steps if you're using an existing Clavata policy.

Adding the API Key and Policy

In order to allow your Discord Bot to communicate with your Clavata instance you will need to provide an API key and a Policy Id. Both of these are simple to get. Your API Key was provided to you when setting up your instance and you can access your Policy Ids whenever you want.

• Your API key will be a long series of letters and numbers.
• Your Policy Id can be found in your Policies tab in Clavata and to the right of a policy's name.

Adding the bot to your server

You will need a specific link in order to add the Discord bot to your server, along with the appropriate permissions. Server owners, and admins typically have this permission but your admin roles and responsibilities may differ from server to server. Follow the below instructions to add the bot to your server.

1. Paste the URL you've been given by Clavata into your browser of choice.
   1. Note: you will need to be logged into Discord
2. You will see a pop up asking you to add 'ClavataBot' to a server.
3. In the 'ADD TO SERVER:' dropdown, select the server you would like to add the bot to.
   1. Note: if you own multiple servers you will see a list of all of them. Be sure to select the correct one to ensure the bot is added to the correct server.
4. Clicking 'Continue' will allow you to proceed to adding the bot

Inside your Discord server, the bot will ask you to enter setup mode and enter your API credentials and Policy Id.

Clavata bot commands

/clavata setup

This will have you enter the setup modal where you can enter your API Key and Policy Id and should be the first command you run after installing the bot.

/clavata show

This command will give you an overview of your current settings for Clavata Bot

• API Key - your API Key used by the bot to
• Policy ID - is the current policy your bot is using to evaluate content
• Channels - the current Channels your bot is monitoring and evaluating
• Active - whether the bot is actively making decisions or not
• Mod Actions - displays the current Mod Actions the bot is taking when it finds a violation against your policy

/clavata actions set

This will allow you to set moderation actions for your bot to perform when it finds a policy violation. Click on one or more actions to set them.

• Notify the admin via DM
  • This notify admins via a DM that a violation was found
• Delete the message
  • This will delete the violating message
• Warn the user
  • This will send a warning message to the user about the violating message
• Timeout the user for 10 minutes
  • This will prevent the user from doing any actions on the server for 10 minutes
• Kick the user
  • This will kick the user from the server but will allow them to join back if they have an invitation link
• Ban the user
  • This will ban the user from the server. They can't join again unless the ban is removed

/clavata actions clear

This will clear any moderation actions you've set in your 'actions set' command.

• Notify the admin via DM
  • This notify admins via a DM that a violation was found
• Delete the message
  • This will delete the violating message
• Warn the user
  • This will send a warning message to the user about the violating message
• Timeout the user for 10 minutes
  • This will prevent the user from doing any actions on the server for 10 minutes
• Kick the user
  • This will kick the user from the server but will allow them to join back if they have an invitation link
• Ban the user
  • This will ban the user from the server. They can't join again unless the ban is removed

/clavata active yes

This will enable the bot to take moderation actions if set.

/clavata active no

This will disable the bot so no moderation actions are taken.

/clavata auth

This will allow you to set an API Key for your instance.

*insert picture after confirming you won't wipe the API Key

/clavata channels set

This will allow you to set the channels you would like the bot to monitor. Leave this blank to monitor all channels.

/clavata channels clear

You can this command to clear any channel selections made and monitor all channels

/clavata policy

This will allow you to set which policy you want the Discord bot to use.