# What is Modr8? Modr8 is a white-label Telegram community bot platform - We provide the engine, settings and customisations all for a bot registered to you, with your branding and bot profile. Telegram is a brilliant platform for small to super large communities to come together and chat in real-time. Often when managing a thriving group chat you need a little helping hand to moderate, announce and provide growth options. This is where a Modr8 powered bot can step in! With your Telegram bots brain being powered by Modr8 you can rest easy knowing it is protecting your community from spam as well as being able to automate announcements and gamify your chat with reputation ranks and point based systems. {% hint style="success" %} If you're ready to get started check out our [tutorial here](/getting-started/register-a-bot)! {% endhint %} **Community Managers** :heart: **Modr8 Features** * Spam Prevention * User Management & Analytics * Scheduled Announcements & Social Integrations * Custom Commands & Rules Engine * Polls & Quizzes * Community Reputation & Referrals If you are looking for an all in one community management bot, whilst being able to control your bot profile to suit your brand then Modr8 is the perfect fit! Don't just take our word for it though - Modr8 is handling community moderation from small private groups to global brands. Feel free to browse our user guide and documentation which will walk you through the process of creating your own Telegram bot, registering it to our platform and managing all of the settings and features you may need.\ \ If you need further support or have any questions, why not [join our very own Telegram community](< https://t.me/modr8support>), where you will meet Modr8 platform users just like you and be able to contact our support team direct. ### Quick Links Modr8 Community & Support Chat - Modr8 Platform - Modr8 Standard Command List - # Feature Overview Modr8 is the ideal Telegram community moderation engine due to the vast number of features available on the platform. The following sections provides a comprehensive view of full system. ### Standard Bot Features Everything you would expect us to do without a fuss! * [Warning System](/features/bot-general-behaviour#user-moderation-warning-system) * [Bot Translations](/features/bot-general-behaviour#changing-bot-language) * [User Administration Commands - Ban, Warn, Purge & Mute](/features/commands/built-in-commands) * [Remove Join / Leave and Pinned Message Notifications](/features/bot-general-behaviour#service-message-deletion) * [Import & Export of Settings](/features/bot-general-behaviour#export-and-import-chat-settings) * [Team Access](/getting-started/team-access) * [Verify You Are Chatting To An Admin](/features/admin-verification) ### API Access * [Retrieve a list of registered chats](/features/api-access-and-zapier-integration) * [List tracked users within your chats](/features/api-access-and-zapier-integration) * [View the profile of a user within your ch](/features/api-access-and-zapier-integration)[at](/features/api-access-and-zapier-integration) * [Retrieve all user reputation points](/features/api-access-and-zapier-integration) * [Add / Remove user reputation](/features/api-access-and-zapier-integration) ### Media & Text Filters Adjust which types of media to allow in your chat such as images, voice and locations. * [Remove Media such as Animation, Voice, Contacts, Documents, Stickers, Polls & Photos](/features/media-and-text-filters#media-management) * [Trusted / Un-trusted Forwarded Message Filter](/features/media-and-text-filters#forwarded-content-filter) * [Profanity Filtering](/features/media-and-text-filters#profanity-filtering) * [Trusted / Un-trusted website, group & contact links.](/features/media-and-text-filters#link-filtering) * [Excessive Emojis Filter](/features/media-and-text-filters#excessive-emojis-filter) ### Spam Prevention Settings to detect, prevent and act upon various spam attacks on your group. * [New User Spam Capture - block forwarded messages, links, mentions (chats/users)](/features/spam-prevention-and-protection#new-user-spam-capture) * [New User Restrictions to prevent media, user invites or media being sent for X time](/features/spam-prevention-and-protection#new-user-restrictions) * [Federated Spam Protection to ban joining users who have been matched to SpamWatch lists](/features/spam-prevention-and-protection#federated-spam-protection) * [Duplicate Message Remover](/features/spam-prevention-and-protection#duplicate-message-checking) * [Message Flood Control](/features/spam-prevention-and-protection#message-flood-control) ### Community Moderation Adjust whether non-admins of the group are able to help with moderating the chat. * [Enable /report commands for trusted / all members](#community-moderation) * [X number of reports before deletion](#community-moderation) * [Mute user after being reported](#community-moderation) * [Issue reported message for Admin review](#community-moderation) ### Welcome Messages & Human Verification (Anti-bot Checks) Welcome new users with a message and prevent fake accounts joining the chat. * [Welcome new users with a message & media inc. Personalised messages](/features/welcome-message-and-human-check#creating-your-welcome-message) * [Message buttons for Web links, Command Execution & Actions](/features/welcome-message-and-human-check#adding-buttons-to-your-message) * [3x Variants of human verification checks](/features/welcome-message-and-human-check#adding-human-verification-and-captcha-checks) * Button Click * Answer Maths Question * Review & Approve Chat Rules * [Remove new users if not verified after x time](/features/welcome-message-and-human-check#adding-human-verification-and-captcha-checks) ### User Filters Options to manage the type of users that are allowed to enter and engage with your group. * [Ban re-join Flooding](/features/user-filters#ban-re-join-flooding) * [Disallow Telegram Bots](/features/user-filters#disallow-telegram-bots) * [Ban or Kick Disallowed Names on user joining](/features/user-filters#name-filtering) * [Ban or Kick Disallowed Names on messages being sent](/features/user-filters#name-filtering) * [Remove "Idle" users (Those who have not sent or interacted with the chat in X time)](/features/user-filters#remove-idle-users) ### Community Reputation Allow users to say thanks and generate a reputation score and ranking within your community. * [User Reputation points & rankings](/features/community-reputation#enabling-reputation-module) * [Customise rank names and images](/features/community-reputation#adding-reputation-ranks) * [Top rank lists & history](/features/community-reputation#how-do-chat-users-give-out-reputation) * [Export reputation history & snapshots](/features/community-reputation#exporting-and-deleting-reputation-data) * [Automatically "trust" users after X reputation](/features/community-reputation#advanced-settings) * [Global reputation ranks across your bot chats](/introduction/global-and-multi-chat-features#global-reputation) * [Multi-rep and Admin bypass rep limits](/features/community-reputation#advanced-settings) * [Limit reputation replenishment per X time](/features/community-reputation#limiting-reputation) ### Community Referrals Allow users to generate unique invitation links which can then be used to track referrals to your community. * [User referral links & invite codes](/features/community-referrals#how-to-enable-the-community-referral-module) * [Referral tracking and analytics](/features/community-referrals#how-to-track-manage-and-export-referrals) * [Export referral snapshots & history](/features/community-referrals#how-to-reset-the-referrals-system) * [Audit referrals](/features/community-referrals#how-to-track-manage-and-export-referrals) * [Referral top ranks](/features/community-referrals#how-to-track-manage-and-export-referrals) ### Advanced Settings Power features such as permissions and text pattern filtering. Advanced use cases! * [Restrict bot commands dependent on admin permissions](/features/advanced-features#restrict-admin-command-access) * [Disable moderation commands in chat](/features/advanced-features#disable-built-in-moderation-commands) * [Regular Expression Filters - Pattern matching on message text](/features/advanced-features#regular-expression-filtering) ### Announcements Whether you wish to issue a quick announcement to one chat or across all of your bot managed chats we have you covered. Modr8 can also power your bot to issue scheduled announcements. * [One-off multi-chat announcements (where a bot manages multiple chats)](/features/announcements) * [One-off single chat announcements with text editor & buttons](/features/announcements) * [Scheduled announcements with time to start & stop sending](/features/announcements) * I[nterval announcements with rotating content on each send](/features/announcements) ### Social Announcements Being able to link to your social profiles and announce new posts to your community is great for engagement. Maybe you want to track news headlines and sports too? It's all possible! * [Twitter announcements with live tweets issued each minute](/features/announcements/social-announcements#connecting-twitter-x-announcements) * [Medium announcements issued when a new item is published](/features/announcements/social-announcements#connecting-medium-blog-announcements) * [RSS feed based announcement on new articles being identified](/features/announcements/social-announcements#connecting-rss-feed-announcements) * [YouTube announcement upon new video being uploaded to channel](/features/announcements/social-announcements#connecting-youtube-announcements) * [Zendesk articles issued to chat when published](/features/announcements/social-announcements#connecting-zendesk-announcements) * [Twitch announcement issued when stream is identified to go online](/features/announcements/social-announcements#connecting-twitch-stream-announcements) ### User Management & Analytics Being able to track the users in your chat and view their profiles for active engagement is a powerful tool for any community manager. Modr8 will show you their activity as well as actions taken. * [Tracking user profiles](/features/user-management#accessing-the-user-management-console) * [Search & export of tracked users](/features/user-management) * [Identify warned, trusted and banned users](/features/user-management#managing-tracked-users) * [Track languages & reputation points](/features/user-management#managing-tracked-users) * [Issue bans, warns and mutes from UI](/features/user-management#managing-tracked-users) * [View user profile, message history & sentiment](/features/user-management#viewing-user-profiles) * [Identify referred users](/features/user-management#viewing-and-managing-reputation-history) ### Chat Analytics Want to know when your busiest hours are? or maybe you want to see whether your referral campaign is leading to more growth! Our live charts will keep you up to date. * [Join / Leave and Churn tracking](/features/analytics) * [Message sentiment analysis](/features/analytics) * [Message type breakdown inc. image / video / voice etc.](/features/analytics) * [Track moderation actions - ban, warn, mutes](/features/analytics) * [Open and completed user referrals](/features/analytics) * [Language region tracking](/features/analytics) * [Popular hours & days](/features/analytics) * [Export chart data](/features/analytics) ### Polls & Quizzes Telegram polls are great for actively engaging your community. Modr8 offers scheduled polls and quizes as well as being able to track which users have provided a response and their answers. * [Issue tracked, anonymous or quiz type polls](/features/polls-and-quizzes#supported-polls-and-quiz-types) * [Review responses collected](/features/polls-and-quizzes#managing-and-tracking-polls-and-quizzes) * [Scheduled opening & closing](/features/polls-and-quizzes#how-to-create-and-issue-a-polls-and-quizzes) ### Actions Our "if this then that" actions are what really set Modr8 apart from the rest. We offer the most comprehensive rule engine on the market. If you can't find a standard setting, then an action is going to cover your use case. * [Fully customisable "if this happens, then do that" rule engine](/features/actions) * [Rules based on messages, user profiles, actions taken by users](/features/actions) * [OR / AND rule conditions](/features/actions/action-groups) * [Issue messages, adjust reputation, delete messages and personalise media sent](/features/actions/action-groups#availability-of-actions-to-be-run) * [Action marketplace for community generated recipes](/features/actions/using-the-marketplace) * [Import & Export actions](/features/actions/managing-importing-and-exporting-actions) ### Commands A telegram bot engine wouldn't be much use without being able to build your own commands! Choose when they trigger and provide a description which will show in the chat when users want to see the full menu. * [Built in moderation commands for chat](/features/commands/built-in-commands) * [Create your own commands](/features/commands/creating-and-managing-custom-commands#creating-a-custom-command) * [Personalise command output with injectable user profile attributes](/features/commands/creating-and-managing-custom-commands#creating-a-custom-command) * [Buttons for links, action execution or command execution](/features/commands/creating-and-managing-custom-commands#creating-a-custom-command) ### Chat Timeline & Event Log Being able to see events after the 48 hour cut off on Telegram isn't possible, but the Modr8 engine keeps an indefinite amount of history. We also offer a chat event log, which allows your community admins to view the actions of the bot in a single place and take moderation actions themselves. We have some communities using an admin log for over 30 of their chats to manage from a centralised place! * [Live chat timeline with bot actions being taken](/features/timeline-and-event-log#how-to-view-the-chat-timeline) * [Track user profiles](/features/user-management#accessing-the-user-management-console) * [Connect an "admin" event log chat](/features/timeline-and-event-log#setup-the-chat-event-log) * [Review and re-approve deleted messages from main chat](/features/timeline-and-event-log#configure-event-log-settings) * [Notify event log chat on new users, leaves, filtered messages & reputation changes](/features/timeline-and-event-log#setup-the-chat-event-log) * [Moderate messages issued to event log chat - mute, warn, kick, ban and trust](/features/timeline-and-event-log#configure-event-log-settings) # Pricing & Subscriptions ### Overview Modr8 is a feature rich Telegram community bot platform with flexible pricing plans to suit all types of users. Read on to find out about pricing criteria and the extensive free tier options we have. Here's a quick overview of how our pricing works: * Telegram channels are **free** forever. * Our pricing is charged on a ***per chat*** basis and is a flat fee per month. * All features are unlocked & available - there's no hidden features behind paid vs. free plans. * Chat communities with 100 or less members are **free** * Chat communities above 100 members will be required to purchase a subscription. * A paid subscription has unlimited chat members, meaning you will not see your price increase if your community increases from 101 - 200,000 members. Modr8 is a simple flat fee so you can be sure your payments remain the same. {% hint style="info" %} Jump to our pricing tiers on our platform :point\_right: {% endhint %} #### Example Pricing Scenarios 1. **Bot is added to a Telegram Channel** - You gain access to our channel features for free. 2. **Bot is added to a Telegram Chat with less than 100 members** - You gain access to our chat features for free. Each day we will check your member numbers and auto-subscribe you to our free plan if 100 or less members exist. 3. **Bot is added to a Telegram Chat with more than 100 members** - You can begin a free trial for 3 days to try out the platform. Alternatively if your trial has expired or you do not want to wait, you can purchase a subscription for your chat. {% hint style="info" %} Since Modr8 is free for groups of 100 or less, it is often best to try out our platform in a small private group before moving your settings over to your larger community! {% endhint %} ### What subscription options are available? Once your chat meets the criteria of needing a paid subscription we offer two types of payment options. 1. One-off Payments - Pay as you go per Month or Annual 2. Ongoing Payments - Subscribe to pay each Month or Annually We charge slightly more for one-off / pay as you go payments compared to our ongoing subscriptions due to the added flexibility this gives. Often, we have found customers want to test the bot out for a couple of months where a pay as you go plan works perfect, after that they switch to ongoing subscriptions. All of our payments are handled by [LemonSqueezy](https://www.lemonsqueezy.com/). They help us to handle sales tax calculations and security for payment processing and subscriptions. You'll see their e-mails when you purchase to provide you with a receipt and downloadable invoice! ### What are Modr8's current chat prices? Live prices for our subscription and one-off plans can be[ viewed here](https://platform.modr8.net/member/pricing). We've also listed them below for convenience.

Pay as you go pricing - Pay for the number of months or years you wish upfront.

Ongoing Subscription pricing - Pay per month or per year at an ongoing basis. Renews on the anniversary of first payment.

| Name | Payment Type | Price | | --------------------------------- | -------------------------- | -------------------------------- | | Grass Roots - 100 or less members | Free | Free | | Standard - Monthly | One-off - Pay For X Months | $9.99 per chat | | Standard - Annual | One-off - Pay For X Years | $99.99 per chat | | Standard - Monthly | Monthly - Ongoing | $8.99 per chat renews each month | | Standard - Annual | Annual - Ongoing | $89.99 per chat renews each year | ### Do you offer free trials? Yes - every chat has a single free trial option available for 3 days. To start a free trial, once you have activated your chat you will be able to start your free trial by selecting the "Trial / Purchase" button as shown in the screenshot below.

A chat which has yet to use its free trial

You will then be able to start your trial.

Begin a free Modr8 trial on the purchase page

### What payment methods do you accept? Our payments are processed securely by [LemonSqueezy](https://www.lemonsqueezy.com/). At present we are accepting payments from: * Cards (we accept Visa, Mastercard, American Express, Discover, Diners Club, JCB and China UnionPay from customers worldwide) * PayPal * Apple Pay (Safari only) * Google Pay (Chrome only) * Alipay * WeChat Pay * Cash App Pay * Bank debits (e.g. ACH) ### Do you accept Crypto payments? No - Unfortunately due to Global Sales Tax rules, the lack of clear regulatory information for each jurisdiction and the overhead in processing we can not offer cryptocurrency payments at this time. ### Do you offer commission for referrals / affiliates? Yes - Check out the Modr8 affiliate campaign information [here.](/popular-questions/affiliates-and-partnerships) You can earn $$ for referring other users to Modr8. ### :question:FAQ & Troubleshooting
How can I amend my subscription details? We use LemonSqueezy as our merchant of record, so they handle all of this for us.\ \ You can use our dedicated portal to make any changes to your details shown on your subscriptions by accessing the following link:\ \ \ Please use the e-mail you gave us during checkout to login.
How can I cancel an ongoing subscription or change the payment details? To cancel an ongoing subscription at any time you can go to the customer portal here:\ \ \ Use the e-mail address you provided during checkout to view the details.
# Global & Multi-Chat Features When a small community grows, often you will begin to split it up into multiple chats. These could be regional chats for country specific topics, or even chats related to different areas of your business.\ \ Modr8 handles these enterprise setups by allowing you to activate multiple chats with the same bot. The benefit of doing so is that you open up Modr8's "Global" features. The diagram below shows how global commands, announcements and reputation can be used across all of the bot registered chats.
### Global Announcements Whilst your bot can issue a chat level announcement (an announcement that will go just to that chat), once you activate multiple chats your bot can issue "Bot Announcements". When a bot announcement is sent, a copy of it is issued out to all active chats the bot is in.\ \ This feature is great for issuing community wide information, maybe an offer, maybe an important service announcement or ongoing messaging. To learn how to issue global announcements check out our [dedicated guide here.](/features/announcements/global-bot-announcements) ### Global Commands Your Modr8 powered bot comes with a set of standard moderation commands. These are great for issuing warnings, banning users, kicking users and muting. What if you wanted to globally ban a particular user from all of your managed chats? That may normally be quite painful, but with Modr8 you can utilise our list of "Global commands" to ensure the same action is taken across all of your chats. The table below lists the global commands available, if one is issued in any of your activated chats, it will apply to all of your bots chats.
CommandDescription
/gbanGlobally ban a user from all chats associated with your bot. They are unable to enter any of your chats.
/gunbanGlobally remove a ban from a user to ensure they can re-enter the chat.
/gkickGlobally remove a user from your chats, they can re-join after 30 seconds.
/gwarnIssue a warning which is recorded against a user in all of the chats your bot manages. This may trigger additional actions dependent on the chats individual settings.
/gwhitelistEnsure a user bypasses all of your standard bot filters by adding them to the global trust list
{% hint style="info" %} Interested in seeing all of the standard commands your Modr8 powered bot has? Check out our [command list here.](https://platform.modr8.net/member/botcommands) You can also get a list by messaging your bot in private and sending the text: `/commands` {% endhint %} ### Global Reputation If your chat is running the community reputation module, you may wish to combine the reputation a user has gained from other chats your bot manages. This is a very useful feature if you wish to ensure they are rewarded for participating across your overall community rather than just a single chat. Each of your chats can choose whether they wish to show global reputation or just local reputation rankings. To enable this feature enable it in the community reputation settings for the chat. # Register A Bot Most other "community bots" out there require you to use their bot and their brand, but not with Modr8! Think of Modr8 as a platform with the brains & engine to your moderation bot. We offer the settings and rules, your community won't even know you use us, they will probably think you developed it yourself! To get started we will walk you through the steps of registering a bot with @BotFather the official Telegram bot creator and show you how to connect it up to our platform. Lets begin... ### :zap:Quick Instructions Here is a quick overview of the process. Read on for the full guide though if you need more information! 1. Select to create a bot on our [website](https://platform.modr8.net) 2. Register a new bot with [@BotFather (click here for quick access)](https://t.me/BotFather) 3. Add the provided Bot Token (HTTP API Token) to the bot creation page 4. Move on to [adding your chats!](/getting-started/add-your-chat) {% hint style="info" %} Already have a bot you wish to use with Modr8? Check out the steps to take in [our FAQ here.](https://docs.modr8.net/getting-started/register-a-bot#i-have-a-bot-already-created-i-want-to-use-with-modr8) {% endhint %} ### :books: Full Guide To Registration All of your bot settings and management is handled on our dedicated desktop and mobile friendly platform. {% hint style="info" %} If you are unable to login with the steps provided you can always message our official [Modr8 bot](https://t.me/Modr8_bot) and send the command `/otp` this will issue you a link to click which logs you in. {% endhint %} 1. Navigate to & click "Open The Platform" 2. When prompted - enter your phone number and click "Next", you will soon receive a notification from Telegram to confirm the login. Once confirmed, you will be automatically redirect to the main platform homepage 3. Select to "Create" on the "Create A Bot" card - this will then provide you with instructions on what happens next. 4. Start a conversation with [@BotFather (click here for quick access)](https://t.me/BotFather) - BotFather is the official Telegram bot used to register/create bots on the Telegram platform. 5. Type `/newbot` in the conversation window with @BotFather 6. You will be prompted to provide a name for your bot, this is the name users will see when talking to the bot. Enter a name to continue. 7. You will be promoted to provide a username for you bot, this is the name users will see when linking to your bot or searching for it. Enter a username, ensuring `bot` is at the end. 8. `@Botfather`will respond with a bot token "Use this token to access the HTTP API" - copy the long token. In the example image below it is `6868510939:AAEVOYde4F1lLwHw7xjqOpR2ED5YMHnOT0I` - yours will be different.

Full Chat With BotFather To Register A Bot

9. Paste the token into the Modr8 platform text box "Your Bot Token:"
10. You will be informed of a successful registration and can read up on any further action to take. Click the button at the bottom of the page to be returned to the platform homepage. You will see your bot profile card.

Bot Profile Card on the Modr8 Platform Homepage

{% hint style="success" %} Now your bot is registered you can move on to [adding your chats](/getting-started/add-your-chat). {% endhint %} ### :question:FAQ & Troubleshooting
The "Open Platform" button does not respond when logging into your website We use the official [telegram login widget ](https://telegram.org/blog/login)for websites. If you have a browser which blocks cookies or javascript this can cause the widget login process to fail.\ \ Fear not - if you are unable or unwilling to enable 3rd Party Cookies or Javascript to run we have provided a 2nd method to login via our OTP link (one time passcode link). To be provided with a link complete the following steps: 1. Message your bot in private or click here to message Modr8s official bot direct 2. Click "Start" button if you have not chatted with the bot before (skip step if you have). 3. Type `/otp` and click to send 4. The bot will reply with a messgae explaining how long the link lasts for and click the button to login 5. A new browser window will open and you will be logged into the platform
I have a bot already created I want to use with Modr8 Not a problem at all - We often have users who may have a Bot they created previously for other purposes that they want to use with the Modr8 engine.\ \ You MUST re-generate a new bot token. If you have used the bot token before on another platform or for your own integrations then Modr8 will not be able to connect correctly to receive updates from telegram. To generate a new Bot token complete the following steps: 1. Start a conversation with [@BotFather (click here for quick access)](https://t.me/BotFather) 2. Type /revoke 3. Select your bot from the list 4. You will be provided with a new Token. Copy the long token at the bottom of the message and continue registering your bot with Modr8 on our website
I receive an error that a bot already exists on your platform with the token provided This can happen when our platform detects that the unique bot identifier is already known to Modr8. As the reasons can be quite broad for this to happen here are some basic checks: * Ensure you are logged into the platform with the correct Telegram profile * Scroll down the main platform homepage to see if your bot has been registered in the list before * Delete your old bot profile if you do not want it anymore If you are still stuck feel free to send a message in our [support community ](https://t.me/modr8support)and we can look into the issue and advise better.
My bot has stopped responding to my other systems since registering with Modr8 When working with Telegram bots all systems use the bot token to communicate back and forth with Telegrams systems. If more than one integration is trying to use the same token then there are conditions where only some messages or no messages are received. We always recommend to use one bot per integration/system to ensure each receive the correct updates. \ \ If you notice your bot has stopped responding to Modr8 then you can regenerate a new bot token and replace your token in our platform by completing the following steps. 1. Start a conversation with [@BotFather (click here for quick access)](https://t.me/BotFather) 2. Type /revoke 3. Select your bot from the list 4. You will be provided with a new Token. Copy the long token at the bottom of the message. 5. Select "Manage" button on your bot profile on our website 6. Select "Bot Menu" button below your bot profile image 7. Select "Replace token" and paste in your bot token to the pop-up 8. Click "OK" and wait a few seconds as we update Telegram and our platform You should be all set!
# Add Your Chat Once you have completed registering your bot token with the Modr8 platform you can now activate a chat for your bot to manage. Modr8 powered bots can manage any number of chats and there are benefits to registering multiple chats all to the same bot. To checkout our global & multi-chat features read the [guide here.](/introduction/global-and-multi-chat-features) {% hint style="info" %} To ensure the correct chats are registered to Modr8 and you do not have random users spamming your bot in channels/chats you do not know about we require you, the bot owner or a team member to execute a /activate command in a chat you wish to register. {% endhint %} Read on to find out the exact steps of getting your chat registered with Modr8. ### :zap:Quick Instructions Here's a quick overview of the process to activating your first and any subsequent chats. 1. Add your registered bot to your chat 2. Set your bot as an admin with the permissions to "Delete Messages", "Ban Users", "Pin Messages" & "Add New Admins" 3. Run the command `/activate` in your chat 4. Login to the Modr8 platform and select "Manage Bot" 5. Select to begin a [Trial / Purchase](#user-content-fn-1)[^1] if your chat is above 100 members. 6. Now you can move on to check out our [recommended settings.](/getting-started/recommended-settings) {% hint style="warning" %} You can not activate a chat whilst you are set as an anonymous admin. Telegram does not send us the required information to identify you as an owner. Once activated, feel free to switch back to anonymous! {% endhint %} ### :books: Full Guide To Chat Activation Activating your first and any number of chats and channels all follow the same process. We require the bot owner or a team member that is an admin of the current chat to be able to register it on the platform. ### Adding Your Bot As An Administrator First we need to add your bot as an admin to your chat, if you have already done this then you can skip to the next section. If you bot is not an administrator of your chat it is unable to moderate and in most cases it will be unresponsive due to not being able to read messages in your chat due to Telegram privacy settings. 1. On telegram, In your group select the title of the chat in the main window which will open up the group information page 2. If using desktop, select the 3 dots symbol first to bring up the "Edit group" page. If using mobile you will normally have this page already opened for you. 3. Select "Administrators" 4. On mobile select "Add Admin" and click the Magnifying glass icon. On desktop select the "Add Administrator" button at the bottom of the pop-up. 5. Type the username of your bot including the @ symbol e.g. `@MySuperCoolBot` 6. Select your bot from the search list - if on desktop you may need to confirm that you wish to add them to the group and make them an admin. 7. The "What can this admin do / Admin rights" page will pop-up. You will need to set as a minimum the following permissions for your bot to work correctly: * Delete messages - To delete spam messages and clean up its own messages * Ban users - To kick and ban users at a chat / global level * Invite users via link - To allow the referral module to work * Pin messages - To allow /pin & /unpin commands to work * Add new admins - To allow the /promote /demote commands to work. 8. Click "Save" on desktop and the :heavy\_check\_mark: mark on mobile. Your bot will now be an admin of your chat and can read messages being sent to it. ### Activating / Registering Your Chat Now your bot is an administrator it can read messgaes in the chat and the bot owner or a team member can activate the chat. 1. Type /activate in your chat 2. The bot will respond with the message to state the chat has been activated. If this did not work - [checkout our troubleshooting section.](#actions-to-take-if-activation-does-not-work) 3. Navigate to the Modr8 Platform and click the "Manage" button below your bots profile image 4. Observe your chat will be listed with the chat icon and chat identifier below your bot profile. 5. Select to begin a [Trial / Purchase](#user-content-fn-1)[^1] if your chat is above 100 members. 6. Now you can move on to check out our [recommended settings.](/getting-started/recommended-settings) You are all set! The chat will be showing the settings, announcements, commands and other buttons ready for you to configure your chat settings.

An Activated Chat On The Modr8 Platform - Settings & Other Actions Available

#### :sos: Actions To Take If Activation Does Not Work During activation, the Modr8 bot runs a series of checks to ensure it has the correct permissions and the person running the /activate command has the required access to register the chat. In some circumstances you will receive feedback from the bot about items that need to be addressed. The following section will list the various types of messages and actions to take.
We do not allow first activation to be executed by an anonymous group admin. If you are set as an anonymous admin in your chat then Telegram bot server does not send us any information to be able to identify whether you are the bot owner. **Action To Take:** To be able to /activate correctly you will need to temporarily turn off the anonymous admin setting. 1. On telegram, In your group select the title of the chat in the main window which will open up the group information page 2. If using desktop, select the 3 dots symbol first to bring up the "Edit group" page. If using mobile you will normally have this page already opened for you. 3. Select "Administrators" and select your username 4. In the "Permissions" section turn off "Remain Anonymous"
Command can only be used by the bot owner or those registered as team members. To ensure your bot is not being added to a chat without your knowledge as well as being spammed by rogue users who may be trying to rate-limit your bot with Telegram we only allow the bot owner (the person who registered it on our site) and team members (those who have joined a team on our site) to run the /activate command. **Action To Take:** You can go with any of the following options to activate your chat. * Ensure you are running the /activate command as the owner of the bot * Ensure you have joined the team on our website to run the /activate command if you are not the bot owner * Contact the owner or a team member to activate the chat for you
You must add the bot as an Administrator to use this command. If your bot is not an admin then it is often the case that Telegram privacy settings for bots does not allow the it to see messages in your chat and will not activate correctly. It can also be the case that you did make the bot an admin but due to converting to a supergroup all telegram bots are demoted and need to be promoted to admin again, very annoying. **Action To Take:** Promote your bot back to being an admin of the chat. Follow [our guide here](#adding-your-bot-as-an-administrator) to do so.
Many bot functions will not work unless you convert the chat to a Supergroup. When you create a group for the first time it is known as a "normal group". Once your chat grows to a certain size or when you make it public and enable chat history Telegram in the background converts the "normal group" into a "Supergroup". As a Telegram user you probably didn't know this happens!\ \ Certain moderation features are **only available** for Supergroup chats and the [Modr8 platform](https://www.modr8.net/) uses many of these for restricting new users and spammers. Supergroups were [released](https://telegram.org/blog/supergroups5k) in 2016 but when any new group is created it does not automatically become a Supergroup, it has to first be converted. **Action To Take:** There are 5 ways in which a group can be upgraded to a Supergroup, they are: * Making the group public with its own @Username or public link. * Changing group chat history visibility from hidden to visible. * Restricting a member e.g. Ban. * Changing default admin permissions e.g. change any setting such as pin messages. * Group members reach 196 or more. You can check if your group is already a Supergroup by typing /debug in your chat. If the chat ID begins with -100, then it is a Supergroup, otherwise it is just a normal group and you should execute one of the 5 listed options above to convert it.
### ### :question:FAQ & Troubleshooting
How do I turn my group into a "Supergroup"? Certain moderation features are **only available** for Supergroup chats and the [Modr8 platform](https://www.modr8.net/) uses many of these for restricting new users and spammers. Supergroups were [released](https://telegram.org/blog/supergroups5k) in 2016 but when any new group is created it does not automatically become a Supergroup, it has to first be converted. **Action To Take:** There are 5 ways in which a group can be upgraded to a Supergroup, they are: * Making the group public with its own @Username or public link. * Changing group chat history visibility from hidden to visible. * Restricting a member e.g. Ban. * Changing default admin permissions e.g. change any setting such as pin messages. * Group members reach 196 or more. You can check if your group is already a Supergroup by typing /debug in your chat. If the chat ID begins with -100, then it is a Supergroup, otherwise it is just a normal group and you should execute one of the 5 listed options above to convert it.
What are the minimum permissions required for my bot as an admin? You will need to set as a minimum the following permissions for your bot to work correctly: * Delete messages - To delete spam messages and clean up its own messages * Ban users - To kick and ban users at a chat / global level * Invite users via link - To allow the referral module to work * Pin messages - To allow /pin & /unpin commands to work * Add new admins - To allow the /promote /demote commands to work.
My bot is not responding to the /activate command... help! There can be a few reasons why this happens, we suggest you check for the following items. * Ensure your bot is still an Admin of your chat - sometimes it can be demoted. * Ensure you have added the correct bot to the chat. As Telegram is very popular often people make lots of bots with similar names. * Ensure you have registered your bot with the Modr8 platform. Check our [guide here](/getting-started/register-a-bot) if you aren't sure on what to do.
The bot says it can not activate as I am an anonymous admin To be able to /activate correctly you will need to temporarily turn off the anonymous admin setting. 1. On telegram, In your group select the title of the chat in the main window which will open up the group information page 2. If using desktop, select the 3 dots symbol first to bring up the "Edit group" page. If using mobile you will normally have this page already opened for you. 3. Select "Administrators" and select your username 4. In the "Permissions" section turn off "Remain Anonymous"
[^1]: Trials run for 3 days. If your chat is 100 members or less you will automatically be subscribed to our free plan. # Recommended Settings You've [registered your bot](/getting-started/register-a-bot), you've [activated your chat](/getting-started/add-your-chat) and you want to get up and running as quick as possible.\ \ We're dedicating this section to providing our community with a base recommendation of settings that we know will provide a good balance of cleaning up your chat whilst allowing your community to thrive. {% hint style="info" %} Once you're done here you might want to review our overview of [managing your bot & chat.](/getting-started/managing-your-bot-and-chat) {% endhint %} ### :dash: Clearing Up Telegram Notifications

Chats can become swamped with Telegram Notifications when users join and leave

When a new user joins, someone leaves or a message is pinned you will notice there can be a lot of chat "service messages" stacking up. Modr8 can clean these up for you to ensure conversations flow more smoothly. To automatically clear telegram service notifications turn on the following options: 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behavior & Import"` card 3. Scroll to `"Service Messages"` section 4. Turn on `Remove Join Message`, `Remove Leave Message` & `Remove User Pinned Message` 5. Click `"Save Changes"` button ### :shield:Spam Prevention Whilst Telegram is a great platform for building private and public communities there is of course marketing, scam and phishing attempts from bad actors. Modr8 is equipped with many features to combat these issues including a dedicated Spam Prevention Module. We recommend you turn on the following settings for all of your communities. **Turn on "New User Spam Capture"** - We often find spammers join a community and immediately try to spam, this is really easy to prevent:

Recommended settings to stop first messages from users spamming your chat

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Spam Prevention"` card 3. Scroll to `"New User Spam Capture"` section 4. Turn on `Contains A Web Link`, `Is A Forwarded Message` & `Mentions Channel/User` 5. Select to `"Kick User"` once deleted, this will temporarily remove them from the group **Turn on "New User Restrictions"** - Temporarily disabling media messages for a few seconds on joining can often stop automated spammers issuing images marketing dangerous content:

Blocking media messages for 30 seconds is often enough to stop automated script bots from spamming your chat

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Spam Prevention"` card 3. Scroll to `"New User Restrictions"` section 4. Turn on `"Apply Restrictions"` 5. Select messages types to be `"Media Messages"` 6. Turn on restricting `"User Invites"` to block new users auto inviting new users temporarily, who may be bots or other spammers. 7. Select restricted for `30 seconds` **Turn on "Federated Spam Protection"** - We utilise a known bad actor/user list which is crowd sourced and maintained by SpamWatch. This list contains hundreds of thousands of peer reviewed spammers who have been issuing bad content to other communities. When this setting is turned on, users who match the list are automatically banned by Modr8.

SpamWatch list matching will auto-ban any users who have been identified as a spammer before.

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Spam Prevention"` card 3. Scroll to `"Federated Spam Protection"` section 4. Turn on `"Enable SpamWatch List"` Click the Save Changes button at the bottom of the screen once you have made the necessary edits. ### :wave:Welcoming New Users When a new user joins your chat you want to give a great first impression. Modr8 supports issuing Welcome Messages to new users. These can contain an image/video as well as any buttons which may link to your website or documentation. In addition to a welcome, Modr8 can also request verification to check the user is not a bot. You are free to choose if you want to verify a user or not, but for now lets get a welcome message set up!

Adding a welcome messgae in Modr8 with personalisation added and an image.

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Welcome Message & Captcha Check"` card 3. Turn on`"Welcome Users"` toggle 4. Add your message using the text editor 5. Click `"Save Changes"` {% hint style="info" %} Below the text editor you'll see a link "Personaisation tag guide" click this and it will show you all of the options for personalising your welcome message. As an example adding {{user}} to your message will inject in the users name as a link that can be clicked to view their profile. {% endhint %} ### :closed\_lock\_with\_key:Restricting Media & User Filters Sometimes you have users in your community sharing restricted content. Modr8 supports the removal of all major media types that can be sent by users within your chat. On top of this, we also offer a comprehensive list of user filters including adding banned words in names and disallowing users adding additional bots to your chat. **Restricting Media Types** 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Media & Text Filters"` card 3. Enable `"Remove Media"` under the Media Management header. 4. In the "Remove Media List" we typically recommend to remove `Audio, Contact, Document, Game, Location, Passport, Venue, Voice & Polls`. You are free to add others too.

Blocking certain types of media messages is easy with Modr8 - feel free to pick and choose from the list when you click into the Remove Media List text area.

### **Restricting Links To Other Groups** 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Media & Text Filters"` card 3. Enable `"Block Web Links"` under the Link Handling header. 4. Select `"Blacklist"` under the `"List Behaviour"` option. This means we will disallow any domains/links added to your list. 5. Add `"t.me"` to the `"Add a link or domain"` text box to block telegram invite group links. 6. Click "New Row" and add `"wa.link"` to the new text box to block whatsapp group links. {% hint style="info" %} List Behaviour - This references whether the list of domains you add to your link list acts as a "trusted list to allow" or a "bad list to remove". Sometimes it can be easier to provide a list of links that you trust rather than trying to block every single domain you can think of! {% endhint %}

Blocking website links is easy, make sure to add a new row for each domain you wish to block.

### **Restricting User Types** Stopping certain types of users from joining your chat is a powerful way to ensure your community is clean. Over the years spammers and disgruntled bad actors have tried many ways to bypass admin kicks and bans. Modr8 engine is well equipped to handle these issues with ease. * Select `"Settings"` on your chat profile * Select `"Edit"` on the `"User Filters"` card * Enable `"Ban Re-join Flooding"` under general settings to stop users joining/leaving repeatedly. * Enable `"Disallow Telegram Bots"` so general users can not add bots to your chat. * Enable `"Name Filter"` in the name filtering section * Select to `"Ban"` `on join` as well as `on user message` to ensure users are always removed form the chat. * Within the disallowed names section add the following common names used to scam/spam, with one filter per row: `"admin","support","help","bot".` * Click `Save Changes` button.

Filtering users from your community based on their profile attributes is a quick way to keep your chat clean

There are many more settings you can modify, feel free to check out our features section to review what every option does and how you can adjust them. Once you're done here you might want to review our overview of [managing your bot & chat.](/getting-started/managing-your-bot-and-chat) ### :question:FAQ & Troubleshooting
Do you have any other recommended settings I should turn on? There is no right answer, because of that though we have the Modr8 community chat where you can discuss direct with other community managers and our developers the best option based on the behaviour of your own chats.\ \ Feel free to join our community chat and [ask any questions here](https://t.me/modr8support).
I cant find a setting which will do what I want i.e. banning key words Modr8 basic settings are aimed to cater for the majority of user needs. That being said, there are always cases where each community needs something fully customised.\ \ Modr8 offers "Actions" this is a "if this happens then do that" type of rules engine. For any advanced scenarios or issues you are facing we can always provide you with an action you can import into the platform to take care of it.\ \ Check out our guide on [Actions here](/features/actions), if you are still stuck and just need to be provided with the code to import [contact us in our support community](https://t.me/modr8support) and someone will be happy to help.
# Managing Your Bot & Chat Now that you have a chat setup and you've implemented some changes to your settings to keep the community running it's worth us discussing how your Bot & Chat can be managed with Modr8. ### Managing Your Bot #### Amending & Changing Your Bots Profile Since your Bot has been registered by you with @BotFather the official Telegram bot registration assistant then you own the Bot Profile settings. This means, if you want to carry out any of the following actions you will do so via @Botfather direct.
I want to change my bots profile picture This is done by messaging botfather direct and uploading your new profile image. 1. Message @BotFather or [click this quick link](https://t.me/botfather). 2. Type `/setuserpic` to let the bot know you want to set a profile image 3. Select your bot from the list 4. Upload or paste a Photo file 5. Observe your bot profile picture will be updated once caching expires
I want to update my bots name/username There is good and bad news! The bad news first - you are unable to change your bots username once it has been set. This means the @username / part can not be altered. You will need to register a new bot to do this. The good news is that you are able to change the display name for the bot. To do so complete the following steps. 1. Message @BotFather or [click this quick link](https://t.me/botfather). 2. Type `/setname` to let the bot know you want to set a new display name 3. Select your bot from the list 4. State the new name of the bot, it does not have to end with "bot" unlike the username 5. Observe your bot display name updates once telegram has completed processing the change
I want to show a command list when users type / in my chat Whilst the Telegram Bot API does allow us to manage and change the list of commands displayed when users type "/" in their Telegram app it's really confusing to work with and is fraught with complications when numerous admins of your chats register different commands. We recommend setting commands direct with the bot as the owner so you can manage what is going to be listed to users. Remember, this is going to show the command list in every chat the bot is in. By default Modr8 will automatically list any of the commands you have created on our platform in the "Command Builder" if a user sends the command `/commands` in your chat. It is best to only register "commands" with bot father. You can however use the process outlined below to set any number of commands you want to show. 1. Message @BotFather or [click this quick link](https://t.me/botfather). 2. Type `/setcommands` to let the bot know you wish to set commands to be displayed when a user types / 3. Select your bot from the list 4. State the commands you wish to be stored. The format required is `commandname - command description` as an example send `commands - Our chat commands` this would then show "commands" when a user types / If you wish to register multiple commands you need to have them each of a new line when sending them to botfather. As an example: `command1 - Here's my first command`\ `command2 - Here's my second command`
#### What features of my bot can I manage on the Modr8 website? Given the Bot Profile amendments are managed direct with @BotFather that only really leaves the management of the bot token with Modr8 website and also some of out "bot level" features such as announcements, team access, bot commands (work in private message to the bot). All of the major settings we offer for Modr8 are managed at a "Chat Level", which means each chat that has been activated against your bot can have its own isolated setup, completely personalised to that community. You can even have your bot responding in a different language from one group to the next.
I want to send an announcement to all of my chats through the bot Whilst you are able to click the "announcements" button on each individual chat to send one-off, scheduled and social announcements we also have "bot announcements" which will issue an announcement out across all of the chats the bot has been activated against. To find out how to issue a Global Bot Announcement check [out our guide here.](/features/announcements/global-bot-announcements) To find more out about our Global & Multi-Chat Features check [our explanation here.](/introduction/global-and-multi-chat-features)
I want to delete my bot from the platform There are times when you just want to start over. We get it! The bot owner is the only person who can delete a bot profile from the Modr8 platform as there are serious implications. Deleting your bot from the platform will: * Delete the bot * Delete all chat data associated with the bot * Delete all tracked user data associated with the chats * Remove all settings and team access We are unable to reverse this process, even though we do take incremental backups through the day the overhead to re-processing these for you just isn't possible for us on an individual basis to execute. With all of this being said, if you are still sure you want to delete your bot form Modr8 complete the following steps. 1. Login to the [Modr8 Platform](https://platform.modr8.net) 2. Click the "Manage" button on the bot you wish to delete 3. Select "Bot Menu" button on the bot profile, just below its profile image 4. Select "Delete Bot" - Confirm the deletion.
I want to switch my current bot profile over to another bot I have created Sometimes you may wish to change up your brand or you may have lost access to your previous bot.\ \ There are two options available and it depends on which way works best for you. **Option 1: Register the new bot and leave the old one for dead** * Kick your old bot from your chat, it won't receive chat updates * Register a new bot with the platform * Export your settings, commands, actions and other items from your old bot chats * Import each of the above into the new bot once you have activated the chat with the new bot **Option 2: Manual support intervention** The second option would be for the Modr8 support team to manually detach your old bot from the platform and attach your new bot in its place. This can take some time so we prefer you to choose option 1.
### Managing Your Chat As Modr8 is in command of your registered chat we have better control over it's settings and management. The bullet points below will set out what is managed where. **Managed In Chat via Telegram Apps** The day to day moderation of the chat using standard "bot commands" are utilised from the Telegram app. You will not be managing any of the bots built in settings from here. * Executing Moderation Commands - Our full list can be [viewed here](https://platform.modr8.net/member/botcommands), but these are mutes, bans, warnings, kicks & deletions. * Reviewing private "Event Log" and issuing approvals / moderation events * Commands enabled due to Modr8 modules i.e. /toprep ranks, /report and /toprefs {% hint style="info" %} If you wish to see a full list of general moderation commands available to your chat admins message your bot in private and send the command `/commands` your Modr8 powered bot will reply with a list of all of the commands available to be executed from the chat and what they do. {% endhint %} **Managed On Website via Modr8 Platform** Modr8 main engine settings are all handled on our website. From the outset we have found that managing such a vast array of modules and configuration is horrible when forced to do so via a chat direct with your bot. It is much easier to manage and work with on a website where you have a view of what each setting does and can edit it easily. * Creating & managing custom commands, announcements, polls & actions * Managing tracked users and viewing profiles, referrals and reputation points * Configuring standard settings such as welcome messages, user filters, spam prevention and advanced filters. ### :question:FAQ & Troubleshooting
I am unable to see the bot or my chat on the website Only the bot owner or members of the team are able to manage the bot and associated chat settings on the website. \ \ You might need to be granted access, in which case contact the bot owner and remind them to provide a team access code. A tutorial/guide on how to do so [c](/getting-started/team-access)[an be found here.](/getting-started/team-access)
# Team Access Modr8 allows you to add multiple users to our website in order to manage the bot settings and various chats. Infact, you do not need to be an admin of the activated chat to be able to gain access to the platform. This can be useful if you have a content creator making your announcements but they do not want to be in your community chat as an admin. The following sections will discuss how to create an invite code as well as joining the team.\ \ We will also discuss a unique scenario available on Modr8 where you can have "Community Admins" who are able to be promoted as an admin in your chat, but are unable to execute any moderation commands. This is a great way to promote an "ambassador" without having to worry they ban or remove users from the chat. ### Providing An Invite Code For Team Members The bot owner is able to generate a team access code, from there they can pass this on for others to join the team. The bot owner can also revoke the access code and remove team members when they wish. #### Generating A Code 1. Login to the [Modr8 Platform](https://platform.modr8.net) 2. Click the `"Manage"` button below your bot profile you wish to grant access to 3. Click the `"Bot Menu"` button below your bot profile image 4. Select `"Team Access"` 5. Copy the Team Access Code and send it to your team mates

Example Team Access Code - This can be copied and sent to your team members to join

### Using Your Invite Code To Join A Team 1. Login to the [Modr8 Platform](https://platform.modr8.net) 2. Paste the team access code you have been given into the `"Join A Team"` text box 3. Click the `Join A Team` button 4. Your page will refresh and you will see the bot profile listed 5. Click the `"Manage"` button below the bot profile to view chats to manage

Pasting the team access code into the "Join A Team" input will grant access to a bot and it's associated chats

### Community Administrators - With limited moderation commands Many large communities wish to offer ambassadors roles within Telegram and amend their "titles" to show they have some form of role or rank within the chat. This is often easily done on Discord but for Telegram the user must be an admin in order to receive a title. It can be the case, that these "admins" should not have access to moderation commands. When promoting them to an admin you are able to remove their access rights, but they would still be able to execute Modr8 moderation commands such as /ban /mute /warn etc. Unique to Modr8 we are able to mirror the Admin level permissions set in Telegram to the scope of permissions they can execute when it comes to moderation commands. This means, if you do not allow the admin to "ban users" from your chat, then the command /ban and /kick will no longer execute for them. To turn this setting on in Modr8 complete the following steps. 1. Login to the [Modr8 Platform](https://platform.modr8.net) 2. Click the `"Manage"` button below your bot profile 3. Click `"Settings"` button for the chat you wish administrator actions to be mirrored 4. Select the `"Edit"` button on the `"Advanced Settings"` Card 5. Enable `"Restrict Command Access"` 6. Click `"Save Changes"` Based on this setting being enabled, whenever you amend an administrators permission levels in your Telegram chat the bot will alter the permissions of what commands the user can access with the bot. * Pin messages disabled - Admin can not use /pin and /unpin commands * Ban chat members - Admin can not use /ban /kick /warn commands * Delete chat messages - Admin can not use /purge command * Change chat info - Admin can not /silence or /unsilence chat

Scoping Admin Command Access In Your Chat To Their Allowed Permissions

# Bot General Behaviour When setting up your Modr8 protected chat there are a number of general settings which you may want to adjust. The General Behaviour area is dedicated to quick and simple settings which you most likely set once and then do not need to touch again. So if you are looking to update the number of warnings in the warning system or maybe you want to import or export your chat settings then this is where you will need to be. The following sections will itemise each of the options, explain their usage and how to set them. {% hint style="info" %} Every chat has its own "Settings" this means you can have your bot responding to users in English with 2 warnings before a ban in one chat, whilst responding in Chinese in another chat with the warning system set to 10 warnings. {% endhint %} ### Bot Settings Under bot settings you are able to change the language the bot will respond to users with in its standard moderation notifications as well as how bot commands and replies are cleaned up after being sent.

General Bot Settings are the most basic options you may need to change when creating a new chat

#### **Changing Bot Language** When Modr8 takes action in your chat or outputs some of its standard commands it will use the language you specify in the Language area. To change the default from English to another language complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Bot Settings"` and select a new option in the`"Language"` drop down. 4. Click `"Save Changes"` button #### Allow Anonymous Admins Sometimes you may wish your admins to remain anonymous in your chat, where their messages show up as if they were sent by the chat itself. Whilst this is great for anonymity unfortunately telegram removes so much information that sometimes we are unable to see who is requesting commands and moderation to be executed. \ \ You may remember, during activation of your chat we had to remove anonymous admins, however once that has been completed we can infer the level of access since we do not specifically need to know if an admin is the bot owner of not. To enable anonymous admins in your chat to use your bot moderation features such as /ban /warn etc then complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Bot Settings"` and enable the toggle`"Allow Anonymous Admins"`. 4. Click `"Save Changes"` button #### Delete Bot Replies / Commands When the bot issues a response in your chat to either a command or filter it will leave the message in place for some time. You may wish to adjust how long this response stays visible before being deleted. In addition, you may wish to change how long the actual /command /ban etc stays in the chat itself. Often communities want their bot responses to commands to last for a few minutes, but want the actual command that executed them to be removed quite quickly. To amend these settings complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Bot Settings"` 4. Amend the value for `"Delete Bot Replies After X minutes"` we recommend 5 - 15 minutes. 5. Amend the value for `"Delete Commands After X seconds"` we recommend 5 - 20 seconds. 6. Click `"Save Changes"` button {% hint style="success" %} If you want bot replies to never be deleted then set the value to 0 or a negative number like -1 {% endhint %} ### Disable Bot Moderation Messages You can prevent the bot from sending out messages whenever it moderates a post, allowing moderation to occur silently. For instance, if media is filtered, the bot will no longer announce, "Bob (12345678) this type of media is not allowed in this chat."

Modr8 will issue messages whenever it moderates a users message like this by default.

Typically, these messages delete based on the "Delete Bot Replies" timeout, but you might just want to disable these from sending completed. To turn these messages off you can complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Bot Settings"` 4. Turn the switch on for the `"Disable Bot Moderation Messages"` option. 5. Click `"Save Changes"` button ### User Moderation Warning System Modr8 has a built in warning system which can be used to warn users prior to taking more permanent action against them. On various built-in features you may have seen "Issue Warning" when a filter is matched. The number of warnings before action is taken is configured in the user moderation warning system section.

Modr8 warning system used to provide a X strikes and you are out style of community

You are able to adjust the number of warnings to limit and also the action to be taken. To make changes to the configuration complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"User Moderation Warning System"` 4. Amend the value for `"Maximum Warning Limit"` we recommend 3 - 4. 5. Amend the selected value for the action to be taken when warning limit is reached `"If limit reached then.."` you may wish to mute, kick (non-permanent ban) or ban the user from the community. If you select to mute you can specify the duration for it to last. 6. Click `"Save Changes"` button ### Service Message Deletion When a new user joins, someone leaves or a message is pinned you will notice there can be a lot of chat "service messages" stacking up. Modr8 can clean these up for you to ensure conversations flow more smoothly.
To automatically clear telegram service notifications turn on the following options: 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Service Messages"` section 4. Turn on `Remove Join Message`, `Remove Leave Message` & `Remove User Pinned Message` dependent on which ones you wish to be removed. 5. Click `"Save Changes"` button ### Disable Moderation Commands There can be times where you may use multiple bots within your chat and you don't want your modr8 bot to respond to conflicting commands i.e. /ban /warn etc. Enable the option to disable moderation commands to have your bot ignore these messages.

Disable moderation commands if you have multiple bots in your chat

To disable moderation commands turn on the following option: 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Disable Moderation Commands"` section 4. Turn on `Disable Moderation Commands` toggle. 5. Click `"Save Changes"` button Your bot will no longer respond to any of the built in [Moderation Commands.](/features/commands/built-in-commands) ### Restrict Admin Command Access You may find that you wish to have "Admins" in your chat to provide them with customised "Titles", something that is easy to do on Discord but not so easy on Telegram. Often, these Admins do not have permissions to remove users, ban, change chat info and add other admins. They may however, still be able to use Modr8 bot commands to carry out these actions, since your bot has the required access. To ensure your admins who have a restricted scope of administrative permissions are also stopped from using Modr8 built in bot commands i.e. /ban /pin /warn then you can enable our "Admin Command Access" module.

Disable Modr8 Built In Commands Dependent On Access Levels Granted On Telegram

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Advanced Settings"` card 3. Turn on`"Restrict Command Access"` toggle Your Modr8 bot will now only allow commands to be executed based on the permissions your admin has in Telegram. ### Export & Import Chat Settings When setting up multiple chats you may wish to configure a base set of configuration and then import these into other chats. You may also wish to just take a backup of all of your filters and other bot settings. \ \ To do this we have an import and export settings area. You can use this to extract settings as well as paste in settings to import them.

Import and export chat settings to take a backup or move configuration around quickly

To export your chat settings complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Export/Import Settings"` section 4. Click `"Export Chat Settings"` button 5. Copy the text in the pop up and store it somewhere safe. To import your chat settings complete the following steps 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Export/Import Settings"` section 4. Paste in the text you had been provided when exporting settings previously into the `"Import Chat Settings"` text box. 5. Click `"Import Chat Settings"`
As well as being able to import chat settings from settings configuration text, we also hae the ability to copy settings between chats that the bot is already an admin and is already activated for. To complete a copy-over follow these steps: 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"General Behaviour"` card 3. Scroll to `"Copy Settings Between Your Chats"` section 4. Select a chat to copy FROM in the drop down list 5. Click the `"Import"` button ### :question:FAQ & Troubleshooting
I want the bot to leave responses to our commands in the chat, it keeps deleting them! You will need to set the value to 0 for "Delete bot replies" option in [this settings area](#delete-bot-replies-commands).
How can I export/back up my actions & commands? The general behavior export and back up options only covers the options under the "Settings" area.\ \ To back up / export other areas there are dedicated export all options on their relevant pages. Navigate to the "Actions" or "Commands" pages and click "Export all" buttons to get a copy.\ \ You can then import these back into the relevant chats on the same pages using the "import" text boxes.
# Admin Verification Being able to verify you are talking to a legitimate Admin of a chat as a community member is important. \ \ Telegram over the years has been the prime target for impersonators scamming users into giving out personal information as well as even sending funds or giving out passwords. Often scammers will act as "support" or swap out letters of a persons name to make their profile appear to be that of an admin. They will then contact chat participants direct and offer their help, when infact they are trying to scam!
To combat such cases, modr8 offers "Admin Verification" functionality, where anyone can forward a message they have received from a user to your bot to confirm whether they are a legitimate admin or not. ### How to use the Admin Verification system 1. Select any message received by any user 2. Select forward the message on 3. Type your bots username into the search 4. Your bot will respond to the message to notify whether the user is a known admin or not. **Example - A verified Admin**

A message from an Admin forwarded to the chats Modr8 powered bot verifies the user

**Example - A verified Owner**

The owner of a bot sends a message, which is forwarded on to their bot and verified

**Example - A fake Admin**

A fake admin messages a user asking whether they need support

Forwarding their message to the Modr8 powered bot in the chat in private identifies they are not an admin. Scammer caught!

### How can we inform our community that this functionality exists? We often get asked what is the best method of letting communities know this option is available to them. Instead of trying to chase down all of these users and banning them, educating your community to verify is the best course of action. This can be done by: * Inform users in the welcome message that they can forward a message to verify admins * Set up a scheduled announcement that informs users the steps they can take every 12 hours * Create a command in the bot which can be used by users/community managers to list the steps they can take ### :question:FAQ & Troubleshooting
I forwarded a message but the bot has said the users privacy is too high This can happen - Telegram is a privacy concious platform and it does allow users to restrict their messages from being forwarded, but also the data contained in the profile.\ \ Under these circumstances it is beneficial for your community users to NOT trust these messages. A legitimate admin should have no issue with being visible.
# Welcome Message & Human Check Being able to welcome new members to your community allows admins to provide rules, useful information and links out to wider resources. Modr8 provides the ability to send welcome messages as users join the chat as well as include media such as images and videos. In addition, you may wish to show your links as clickable buttons below the message. To create a welcome message complete the following steps. We will also show you options we have for human verification checks which can often stop automated user bots from joining just to spam your chat with bad messages. ### Creating Your Welcome Message

The user interface for your welcome message builder.

{% hint style="success" %} Looking to personalise your welcome message? Tap the **"Click here for Personalisation tag guide"** below the Welcome Text box to see a list of tags you can add to your message. {% endhint %} 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Welcome Message & Captcha Check"` card 3. Turn on`"Welcome Users"` toggle 4. Add your message using the text editor - you can add personalisation using `{{ }}` tags like `{{user}}` to link to your users name. 5. Click `"Save Changes"` ### Adding Media To Your Message Modr8 supports adding an image, gif or video to your welcome message. If your message is relatively short we will send this image using the native Telegram image functionality with your actual text as a caption. This looks really nice! \ \ If your message is quite long, to bypass the limited character length of captions we will send the image as a web page preview, it will show below the text. 1. Scroll to the `"Image"` input box on the `"Welcome Message"` card 2. Paste a direct link to your media content {% hint style="warning" %} Make sure to use direct link to your image, animation or video. It should end in .png .jpg .gif .mp4. Often when using services like imgur they give you a link to a web page and not the actual image! {% endhint %} ### Adding Buttons To Your Message

A welcome message containing personalisation and a button linking to our Modr8 Announcements channel

To make your messages easier to understand you might want to add buttons to your welcome, rather than a long list of links.\ \ Modr8 allows you to add multiple buttons over multiple rows to your message. We also support buttons that can open a website, execute a custom command or execute an action that you may have built. 1. Scroll to the `"Message Buttons"` area and click the `"Buttons"` button. 2. A pop-up will open 3. Click the `"+"` button to add a new button to the row 4. Give the button a title, which will be shown to users on the button. 5. Select the `"type"` of button i.e. Link, Command or Action * If you select `"link"` then you can enter a website address in the `"Web Link"` input box * If you select `"Command"` a list of your custom commands will be shown to select from * If you select `"Action"` a list of your custom actions will be shown to select from 6. Click `"Save"` to complete the button setup. 7. If you want to add another button follow the same process again, if you want to add a new row click the `"Add Row"` button.

Adding a button to your welcome message can be done by clicking the green button!

Adding your website or another link is easy using the "Link" type

You can add multiple rows of buttons by click "Add Row"

### Preview Your Welcome Message Being able to build a welcome message is great, but you will also want to be able to check how it looks before using it in your chat. The Modr8 platform allows you to send content based messages as preview to yourself to check over the content.\ \ To use this option, simply add some content to your welcome message and then select the "Preview Message" button.\ \ The bot will send you a direct message, in private, with the content of the message. You are able to edit on the fly and keep sending these previews until your welcome looks just how you want. {% hint style="info" %} For message previews to work you MUST start a conversation with your bot first in DM and ensure you have clicked the "Start" button. Telegram does not allow bots to initiate the conversation without a user clicking START in their chat. {% endhint %} ### Adding Human Verification & Captcha Checks Whilst Modr8 offers lots of tools to block spam in your chat there are times you want to try and block the bots and spammers from entering your community before needing other measures. When joining the chat users are automatically restricted from being able to send any content to your chat. To remove this restriction they need to complete verification. You are able to set a time-frame that they need to complete this by, if they do not complete the task they are kicked from the channel and can return to try again after 30 seconds.\ \ The Modr8 engine offers 3 types of verification checks and will be adding more soon. These are: * [**Simple Button**](#option-1-simple-button-click-verification) - Users are required to click a button displayed below the welcome message * [**Review & Accept Rules**](#option-2-request-to-review-and-accept-community-rules) - Users are required to click a button which opens up a direct message with your bot. They will be shown a set of rules/message you define and are required to click to accept. * [**Answer Maths Question**](#option-3-request-to-answer-maths-question) - Users are required to click a button which opens up a direct message with an image of a maths question. The user needs to enter the right answer. Review the following sections to view instructions on how to set these up! #### Option 1: Simple Button Click Verification This is the lowest level of captcha/verification check available. When a user joins the chat they will be presented with your welcome message and a button to verify they are human. To setup this verification complete the following steps.
1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Welcome Message & Captcha Check"` card 3. Turn on`"Welcome Users"` toggle if it is not already on and add your welcome message 4. Scroll down to "`User Verification & Captcha"` section and enable the `"Require Verification"` toggle. 5. Ensure the verification check type is set to `"Simple Button Click"` 6. Amend the text that will be shown on the button by editing the `"Verify button text"` 7. You can enable of disable showing a message in chat when a user passes or fails their check. 8. Amend the amount of time a user has to complete their check using the `"Kick if not verified"` amount which is set in minutes. We recommend leaving this to 3 minutes.

The Simple Button Check displayed below a welcome message to allow users to verify.

The outcome of a "passed" bot check is displayed if this is enabled. The failed check will display similar.

#### Option 2: Request To Review & Accept Community Rules Often community rules are pinned to the chat header or they are mixed into the welcome message itself. You may want to prove users have explicitly accept or read some rules before they can begin to chat in your group. To handle this we recommend you use the Review & Accept Rules verification option. **The rules are displayed in private message** once the user clicks the button on your welcome announcement.

Request users to review a set of rules and explicitly accept them/agree before they are allowed to chat

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Welcome Message & Captcha Check"` card 3. Turn on`"Welcome Users"` toggle if it is not already on and add your welcome message 4. Scroll down to "`User Verification & Captcha"` section and enable the `"Require Verification"` toggle. 5. Ensure the verification check type is set to `"Review & Accept Rules"` 6. Amend the text that will be shown on the welcome button by editing the `"Verify button text"` we recommend using text like the image above. 7. Enter the rules, disclaimer or any other information you wish to be displayed to the user for them to agree to in the `"Rules Text"` input box. This will be displayed in private message to the user! 8. Amend the `"Accept button text"` which is displayed on the agreement button that unlocks the chat for the user and is displayed against the rules text message sent to them in private.

The user is presented the verify button text when joining the chat

The user is redirected to the bot in private message and the rules along with accept button are shown.

#### Option 3: Request To Answer Maths Question Our maths question verification is one of the toughest measures for human verification at this time. It would require a scripted bot to click a button, go to private message and reverse engineer a maths question image to then present an answer. We've found this verification works very good for keeping your chat clean of spam bots.

Request users to verify they are human by answering a maths question in private chat with your bot

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Welcome Message & Captcha Check"` card 3. Turn on`"Welcome Users"` toggle if it is not already on and add your welcome message 4. Scroll down to "`User Verification & Captcha"` section and enable the `"Require Verification"` toggle. 5. Ensure the verification check type is set to `"Answer Maths Question"` 6. Amend the `"Verify button text"` which is displayed below your welcome message to suit your needs.

Upon joining your chat the user can click to verify where they are then sent to private chat with your bot to complete their maths question.

### Send Welcome Message & Captchas In Private Message We've introduced a new feature allowing you to send welcome messages and captcha challenges directly to users via direct messages (DM) rather than in your public chat. This ensures a smoother and more private onboarding process for your community members. When you enable the "Request to Join" option for your chat, new members will be guided through a streamlined process: * **Welcome Messages**: When a user requests to join your chat, a welcome message will be sent to them in a private DM. After receiving the welcome message, the user will be automatically approved to join your chat. * **Captcha Verification**: If captcha verification is enabled, a captcha challenge will be sent via DM. Once the user successfully completes the captcha, they will be automatically approved to join the chat. If the user fails to complete the captcha in time, their request to join will be denied. They will have the opportunity to retry at a later time. #### How to Enable Join Approvals **On Web Client:** 1. **Select Your Chat Title**: Click on the title of the chat you want to manage. 2. **Manage Channel/Group**: Click the three dots (•••) to access the manage options. 3. **Select Group/Channel Type**: Choose the appropriate type for your group or channel. 4. **Enable Approval**: Toggle on the "Approve New Members" option. **On Mobile:** 1. **Select Your Chat Title**: Tap on the title of the chat you want to edit. 2. **Edit the Chat**: Tap the pencil icon to enter edit mode. 3. **Select Group Type**: Choose the type of group you are managing. 4. **Scroll to Enable Approval**: Scroll down and toggle on the "Approve New Members" option. #### Behaviour Details * **Auto Approval After Welcome Message**: Once a user receives the welcome message in their DM, they are immediately approved to join the chat. * **Captcha Completion**: Upon successfully completing the captcha, users are auto-approved to join the chat. * **Denied Requests**: Users who do not complete the captcha within the allotted time will be denied access but can retry the process later. This feature helps maintain the privacy of your onboarding process while ensuring that new members are vetted and welcomed appropriately. ### Disable Bot Managing Join Approvals Your Modr8 bot automatically manages join requests, sending a DM to users and handling their approval based on a captcha or welcome message. However, you can also choose to manually approve users after they receive the DM. Here’s how to disable the bot’s automatic management of join approvals: 1. Go to the `Settings` page in your chat profile. 2. Select `Edit` on the **Welcome & Human Check** card. 3. Scroll to the very bottom to find **Advanced Options**. 4. Locate the `Bot Manages Join Approvals` setting and toggle it off. By disabling this option, your bot will no longer automatically approve users after sending a welcome message, giving you manual control over join requests. ### :question:FAQ & Troubleshooting
Can I show a users name or profile in my welcome message? What tags do you support? Modr8 offers injectable personalisation tags. To use them simply type the attribute between {{}} braces. The image below shows the tags we support for welcome messages:\
My welcome message is not sending when a new user joins Welcome messages can fail for a number of reasons, typically due to limitations in the Telegram server being unable to process various message types. It is worth checking the following items, if they do not fix the issue feel free to contact us on the support chat or community telegram chat. * Your bot is not in your group or is not an admin * Your chat does not have a valid subscription * The image link provided does not have a valid media extension i.e. .jpg / .png / .mp4 * The message has been pasted from another editor and contains HTML that is not supported by Telegram * The message length is too large and can not be processed by Telegram * A button contains a web-link which is being blocked by Telegram, we have seen this happen with some websites Telegram deems as being high risk. To get around the issue just use a URL shortener like bit.ly instead Often we will need to support you to identify the issue, but if you can't wait simply use the points above as a process of elimination. Try with a very simple message first then add on your links, buttons and images.
# Community Driven Moderation Whilst your community managers as well as Modr8 settings can capture spam and bad actors in your chat, what if some is missed or an admin is not around? The answer is to enable our community moderation module. This module will allow your community users to report bad messages to admins and if required can delete and take further action on the message based on your settings for each chat. By enabling this module your community will be able to use the `/report` command when replying to a message.

Allow your community to help protect your chat by enabling the /report command!

### How To Enable The Module

Complete settings for Community Driven Moderation module

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Community Moderation"` card 3. Turn on`"Enable Community Moderation"` toggle 4. Amend the `"Reports Before Deletion"` to the number of times a message needs to be reported for it to be deleted from the chat and issuing a notification. We recommend this being set to 3. 5. Amend the `"Issue Notification To"` to suit your needs, usually informing the Admins & Owner of the bot about a reported message is best. They will receive a direct message from the bot to inform them the message they need to check. 6. Choose whether to enable `"Warn User After Deletion"` which will use the global warning system in your bot and take the relevant action you have specified in your general behaviour page. 7. Choose whether to `"Mute User After Deletion"` and set a duration, which can be a great way to mute a user who is spamming lots of messages prior to an admin being around to take action. The "Advanced Settings" area contains an option to allow whitelisted reporters only, these are your trusted users that you have set to bypass the moderation system. You may wish to only allow these trusted users to use the `/report` command. ### How Do My Users Report A Message? Once you have enabled the module in the instructions above, your bot will activate a new command for your users to run.\ \ In reply to a message your community can type `/report`

Typing /report in reply to another users message will mark it as reported. Admins / Owners will be informed.

The command will also display when a user types /commands in the chat.

Once activated the /report command becomes available and is also shown when running /commands

### :question:FAQ & Troubleshooting
Can users report admin messages? No - admins bypass all of the bot filters as they are trusted in your chat. Using /report against an admin will result in the bot stating it can not report admin messages.
# Community Reputation Saying thanks and ranking users by how well they engage with your community can be done with Modr8's community reputation module. With our engine you are able to reward positive reputation for those that are doing good and if you wish you can enable negative reputation to remove rep from those who are not doing so well. On top of this, with Modr8 you can also gamify your chat by utilising additional custom actions to create jackpots, offer random rep and reward user activity. You are able to set levels / ranks which are obtained as reputation points are earned. Your bot will announce new levels being completed and display an image/gif at the same time.\ \ All of this is a great way to keep your community users engaged and often leads to friendly competition as they check out who ranks at the top of the reputation ranks ### Enabling Reputation Module

The reputation management module settings allow you to specify the scope and what will trigger reputation in your chat

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Community Reputation"` card 3. Turn on`"Enable Reputation"` toggle 4. The `"Reputation Access Control"` option provides a way for you to scope who has permissions to give out reputation to users. * Bot Owner - Only the registered owner of the bot can issue reputation * Admins - Only Admins of the chat can issue reputation * Trusted - Only users who have been added to the trusted/whitelist can issue reputation * Member - Chat members can issue reputation to other members 5. Add in any `additional reputation triggers` you wish to use outside of the standard /rep commands. For example you may want to give reputation to a user using !rep or + or even an emoji like :thumbsup: 6. Click `"Save Changes"` ### Negative Reputation Options As well as being able to provide positive reputation, you may want to remove reputation from users and allow general negative reputation to be issued. If a user has enough negative reputation their reputation points will go into -ve figures and you can use sub zero based ranks for them.
1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Community Reputation"` card 3. Turn on`"Enable Negative Reputation"` toggle 4. The `"Negative Reputation Access Control"` option provides a way for you to scope who has permissions to give out negative reputation to users. * Bot Owner - Only the registered owner of the bot can issue negative reputation. * Admins - Only Admins of the chat can issue negative reputation. * Trusted - Only users who have been added to the trusted/whitelist can issue negative reputation. * Member - Chat members can issue negative reputation to other members 5. Add in any `additional negative reputation triggers` you wish to use outside of the standard /rep commands. For example you may want to remove reputation using - or even an emoji like :thumbsdown: or :arrow\_down: 6. Click `"Save Changes"` ### Limiting Reputation Issuing out reputation is great for building trust and confidence in engaging with your community. To ensure the system is not abused by people trying to gain top ranks by giving each other rep points the Modr8 engine utilises methods to limit the amount that can be given. The following settings can be used to constrain the system to suit your needs.

Modr8 capabilities on limiting reputation that can be used in your chat

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Community Reputation"` card 3. Scroll to the`"Reputation Limit Settings"` section 4. Enter a value for the maximum amount of reputation points that can be given out. 5. Enter a value fro the time limit for this limit to be replenished back to the total value. 6. State whether you want `"Admin users to bypass rep spam limits"`, meaning only your normal members will need to regenerate reputation every x hours, whereas admins will not have a limit. 7. Elect to turn on `"Allow multi-rep to be given"` which allows your users to reply to messages with `/rep X` where `X` is the number of points they wish to issue. As an example you could reply to a message with `/rep 5` to give `5` reputation points to the user. ### Advanced Settings Our advanced reputation management settings are reserved for the custom use-cases communities may have. The options you can enable are listed below along with a description of the behavior and usage in your chat.

Modr8 Advanced Reputation Settings to handle any custom use-cases you may have in your community

* `"Hide Rep Level Up"` - When a user reaches a new reputation level the bot will auto-announce their new ranking in the chat. You can disable this feature though by toggling this switch to hide the rep level up messages in your chat. * `"Show Rank Images in /myrep"` - When a user in your chat wishes to check their rep ranking they will use the /myrep command. This option will also display the associated image with the rank when turned on. * `"Hide User Link In Ranks"` - By default when running /toprep and displaying the top reputation ranks in the chat a link to the users profile will attempt to be displayed (Dependent on user privacy settings). You can enable this option to disable this functionality and simply display the name as normal text. * `"Use Global Reputation"` - This will enable global reputation rankings. When running /toprep or /myrep users will see the reputation points total they have gained from all chats your bot is moderating. Find out more in our guide [Global & Multi-Chat Features.](/introduction/global-and-multi-chat-features) * `"Remove admins from rankings"`- Often we find that the admins of a chat gain the more reputation points due to offering help and engaging with the community. You may wish to remove these users from the /toprep rankings so general chat members can take the top ranks. * `"Trust users with X or more rep points"` - This is a very powerful option which will allow you to automatically trust/whitelist users who gain the number of points specified. The effect this has on the user is that they will then bypass moderation filters. You can utilise this automation with other modules to allow "trusted" users to community moderate or even now be able to give out rep. If there are changes or settings you want outside of the scope of the options above we can always help out! Using "Actions" we are able to make even more customisations to how reputation works in your community. Feel free to drop by our [Telegram Community Chat ](https://t.me/modr8support/)to ask for help. ### Exporting, Deleting & Bulk Modifying Reputation Data Modr8 allows you to export out all of your reputation history as well as a snapshot of the current state of reputation in your chat.
1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Community Reputation"` card 3. Scroll to the`"Data Management"` section The options you will find have the following functionality: * `"Export Reputation Snapshot"` - Provides a spreasdheet download of the current reputation ranks and values your users have in the chat. * `"Export Reputation History"` - Provides a spreadsheet download of how reputation has been added of removed by each user within your chat. A really good tool for auditing reputation! * `"Reset All User Reputation"` - The nuclear option to delete all of your reputation data and start over. Make sure to run exports if you need history! * `"Bulk Modify Reputation Template"` - Once clicked a CSV template will be downloaded, where you can specify user\_id and modification amount to reputation you wish to make. Complete the CSV with changes to rep i.e. adding 10 rep with 10 or removing 10 rep with -10 * `"Upload Template"` - Browse for the CSV file you have edited and select to upload. Once uploaded your changes will be processed and relfect into the reputation scores. {% hint style="info" %} You can use the /resetrep command in reply to a users message or by mentioning the user to set their reputation back to 0. {% endhint %} ### Adding Reputation Ranks Giving out reputation becomes even more fun when users get to gain ranks and even have images/gifs or badges given to them. Modr8 supports the ability for you define unlimited numbers of reputation levels to be obtained.

Adding an unlimited number of reputation ranks for your users to gain!

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Community Reputation"` card 3. Scroll to the`"Set Reputation Rankings"` section 4. You can add a new rank by clicking the `"Add New Rank"` button or you can edit existing ranks 5. Set a `"Level"` value, which is the number of reputation points to be reached 6. Set a `"Rank"` which is the name of the ranking that will be used 7. Set a `"Rank Image"` if you want to display an image or animation when the rank is reached We recommend spacing out your rank levels so that there is time between gaining one to the next. Something exponential like 0, 10, 20, 40, 80, 160 etc. This makes it more fun when gaining ranks. ### How Do Chat Users Give Out Reputation? Once you have your module all set up how you want you will be able to let your chat users know they can now give out reputation. The new standard set of commands that open up when enabling the reputation module are: * `/rep` - Used to give reputation to a user, either directly or by replying to their message. * `/toprep` - Displays reputation point rankings, which can be filtered by time or limited numbers. * `/myrep` - Displays the users current reputation points and how many they have left to give out. The following new commands become available if negative reputation is enabled: * `/remrep` - Removes reputation from a user. In addition to the above, any additional custom rep triggers you made will work too. {% hint style="success" %} When a user types `/commands` in your chat they will see these reputation commands listed with an explanation of their usage. {% endhint %} ### :question:FAQ & Troubleshooting
Why do my reputation rank images not show? This can be due to many reasons but its always worth checking for the following: * You have not supplied a valid image or video file as a DIRECT link that ends in .jpg / .png / .mp4 / .gif * The link provided has been blacklisted/removed by Telegram * The link provided is too big for the Telegram Bot API to send to your chat. We recommend limiting files to 20mb in size. If you are still having issues drop by our [community support chat.](https://t.me/modr8support/)
How can I remove my admins from showing in reputation ranks? You will want to turn on the `"Remove admins from rankings"` setting in our advanced settings section. We've provided information on how to do so [here](#advanced-settings).
How can I see who has given who reputation? We offer a reputation history export which will show the users who have participated in giving reputation, as well as the target user they gave rep to, the amount and any dates. This audit trail should provide everything you need.\ \ We've discussed how to download the reputation history file [here](#exporting-and-deleting-reputation-data).
How can I view reputation ranks in Modr8? Reputation ranks can be viewed in a number of ways. We've listed below the main methods which you can use: * Typing /toprep in your chat will display the rankings. You can expand the list by adding the number of ranks to show e.g. /toprep 10 for top 10, /toprep 20 for top 20 * Running the reputation snapshot export from the data management area of the reputation module. You can find instructions on how to export [here](#exporting-and-deleting-reputation-data). * You can navigate the "Users" page and sorting the list of users by reputation column which will display the full list by total reputation amount.
Can I create jackpots and random reputation wins? Yes - This is where our "Actions" module comes in. We have an example action you can import into your chat listed on our Actions Marketplace. The action marketplace can [be found here](https://platform.modr8.net/member/actions). You will want to scroll down to the "Game" section and copy the reputation jackpot example. We discuss using actions further in our dedicated [Actions documentation.](/features/actions)
# Advanced Features Early / Beta / Preview functionality may start life in "Advanced Features" before being moved over to any of the standard modules.\ \ The following sections outline each of the functions available within the Advanced Features page and their usage. ### Crypto Market Price Data We support looking up price data for over 7500+ crypto trading pairs. This means you no longer need a separate price bot alongside your Modr8 community moderation bot.\ \ There are two options for message output, a full metric set showing price, volume and 24hr price changes OR a simplified output where only the price of the pair is displayed. Within your group your users will be able to lookup market data using the following command formats: ``` /p btc /p btc usdt /p eth btc ```

Modr8 supports over 7500+ crypto trading pairs for quick lookup in your chat.

To enable crypto market data follow these steps: 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Advanced Features"` card 3. Turn on`"Enable Price Commands"` toggle 4. Decide if you want the full metric output or the shortened price only output using `"Message Output Format"` 5. Click Save Changes Once saved, you are able to then use the /p command in your chat. ### Add Your Own Token Price Data In addition to supporting over 7000 standard crypto price points, Modr8 now allows users to add their own custom token if it is available on [Dex Screener](https://dexscreener.com/). This feature is useful for tracking tokens that are not listed on centralized exchanges.

Add your dex based token to modr8 price data

**To add a custom token:** 1. Go to `Settings`. 2. Go to `Advanced Settings`. 3. Ensure that `Enable Price Commands` is toggled on. 4. Find your token on [Dex Screener](https://dexscreener.com/). 5. Copy the full URL for your token and paste it into the **Dex Screener Address** input field. 6. Add your token’s symbol in the **Token Symbol** field. Once added, you can check the price of your custom token by using the `/p` command followed by your symbol. For example, if you set the symbol as "test," you would use `/p test` to retrieve your token's price data. # Community Referrals Do you want to run your own community referral contest? They can be a great way to grow your group and reward those who bring in the most new members to the chat. Often these require a dedicated bot but with Modr8 we support this with our own Community Referral Module. If you don't know what a community referral contest is, the idea is pretty simple! Existing users in your chat are provided with a link that they can pass to other users direct or list on websites. The new user will click this link and be referred/invited to your chat. Once the user has passed relevant checks and joins your chat then the referral is counted.\ \ Many communities run competitions to see who can generate the most referrals within a time period and may even offer a reward. The diagram below shows a general overview of the flow that referrals go through with Modr8.

Overall flow of referral module with Modr8

To provide a realistic example, here is an actual referral flow using screenshots.\ \ Below, a user requests to view their referral stats and unique link by messaging the community bot and typing the command `/myrefs`

User messages your bot and requests to view their referrals using /myrefs

The unique link is then passed on to another user and upon clicking they are shown an invite to join the chat:

User referred to the chat after clicking a unique referral link

Once the user accepts the invite they may be required to complete a human verification check if this is turned on in the welcome message settings. Top referral ranks are updated with the confirmed users who have followed the flow.

Viewing the top referring users utilising the command /toprefs

### How to enable the community referral module Turning on the community referral module is super easy. Complete the following steps to unlock the `/toprefs` and `/myrefs` commands.
1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Community Referrals"` card 3. Turn on`"Enable Referrals"` toggle 4. Turn on `"Hide User Link In Ranks"` if you wish for /toprefs ranks to not have clickable usernames shown 5. Turn on `"Disable /my|toprefs commands in public"` if you do not want users to be able to execute /myrefs and /toprefs in your chat. 6. Decide if you want to issue a private welcome message by enabling `"Send Message On Join?"` We can send a welcome message to the user when they join your chat. This could be useful if you do not want to use a standard welcome message, or maybe you want to show a coupon/discount code to your users as they join.
### How do my community users get a referral link? In order for your current users to generate a referral link they will: * Message your bot in private * Type `/myrefs` We have found it's quite useful to send these instructions as a scheduled message in your chat so people are reminded on how to get their link. {% hint style="info" %} We do not show the users unique link if using /myrefs in your chat. If the command is available we will show the number of referrals made only. Users must use /myrefs in direct message to the bot to see their link to ensure they are not spammed in public. {% endhint %} ### How to track, manage & export referrals We offer multiple ways to track referrals, some of which are available to your chat users and some which are admin only. You will find there are times you wish to audit referrals that have been made to ensure competitions remain fair and no one attempts to game the system. For general chat users the following options are available: * In public chat /myrefs - Will show the users current number of referrals * In public chat /toprefs - Will show the leaderboard of total referrals made * In private chat with bot /myrefs - Will show the users current number of referrals plus their invite link * In private chat with bot /toprefs - Will list chats running referrals module to select and then will show the leaderboard of total referrals made for the chat selected For admins with team access to the Modr8 platform: * Downloadable referral data set as a spreadsheet from the referral module settings page "Download Referral Data" * The user management page for your chat will list the number of referrals against each user if the module is enabled. You can sort and order this list as well as export it from the page * Selecting to "View Profile" when clicking "Manage" beside a user on the user management page will bring up a dedicated section related to referrals. Here you can review each referral they have made as well as choose to delete any you do not wish to be counted. * Analytics page contains two charts. One shows open referrals which are people who have clicked a referral link but did not join the chat. Closed referrals are the number who completed the full flow. This serves as a good pipeline of how many referrals you can expect to see through your chat. ### How to reset the referrals system You may want to reset the referral rankings every so often. Modr8 allows you to delete the current data and start over. We often find community managers do this to run multiple campaigns through the year and give new users the chance to gain top ranks.
1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Community Referrals"` card 3. Click the red button labelled`"Reset"` ### :question:FAQ & Troubleshooting
My users are reporting they can not see their referral link There can be a few reasons this happens, we suggest you check the following * Referral module is enabled and has not been turned off by another admin * A user MUST be in your chat in order to be provided with a referral link to invite others * Users must message your bot in private/direct message with `/myrefs` to get a link. It will not be displayed in public.
My users are reporting that their referral count is not updating In order to stop bad actors gaming the system (often the case in other referral bots) we require new users to complete the following to be counted towards a successful referral: * Clicked and joined via the referral link * Passed the human verification if this has been enabled in the welcome message settings * New user has remained in the chat and did not leave * Owner of the link is in the chat and has not left * You may have removed the bots ability to invite new users to the chat. Check your admin permissions for the bot.
The link being used to join my chat has expired how can I fix this? Sometimes admins will remove all Telegram invite links OR you may change your chat username and lose the official public link. To generate a new link to fix the issue you can simply disable, save and then enabled and save the referral module again. This wil force a new unique link to be generated by the bot.
# User Filters Modr8 has an array of built in options for you to filter users based on their names and other profile properties. Whether you wish to keep certain usernames out of your chat or you have identified someone is joining and leaving repeatedly you can use our user filters module to take action.

Modr8 engine supports removing those who keep leaving and joining the chat as well as other Telegram bots

### Ban Re-join Flooding Spammers or disgruntled users may keep leaving and joining your chat to spam their profile / username utilising the Telegram service notifications. Often bots use this tactic to advertise their crypto project or web links that are listed in their name.\ \ To stop this from happening Modr8 can monitor for users who are re-joining more than 3 times in 24 hours and permanently ban them. To turn this setting on complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"User Filters"` card 3. Turn on`"Ban Re-join Flooding"` toggle 4. Click the `"Save Changes"` button ### Disallow Telegram Bots Sometimes you simply do not want to allow users to add their own Telegram bots to your chat or maybe someone has added a telegram bot to the chat already and it is spamming messages. Modr8 can detect when a user profile is a registered bot with @BotFather and take action to ban them from the chat. To turn this setting on complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"User Filters"` card 3. Turn on`"Disallow Telegram Bots"` toggle 4. Click the `"Save Changes"` button ### Disallow Sent As Channel Messages Premium Telegram subscribers who have a public channel they own are able to switch the profile they send messages as in your chat. This means, if they wanted to promote their own channel or anonymise who they really are they can simply switch to the profile of their channel and start sending messages to your chat. In Modr8 you are able to turn on the following setting for your bot to identify these messages and delete them from your chat. To turn this setting on complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"User Filters"` card 3. Turn on`"Disallow Sent As Channel Messages"` toggle 4. Click the `"Save Changes"` button ### Name Filtering Being able to remove users attempting to join and/or when sending messages to your chat can be a useful way of removing most spammers. Often, spammers join with one username / first name and once inside your community will change it to be something else. This could contain a weblink or other content you do not wish to see. \ \ Using the Modr8 name filtering module you can elect to remove users with names that match key words of your choosing.

Being able to remove key words within users names is a great way to keep fake support agents away from your chat

To turn this setting on complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"User Filters"` card 3. Scroll to the `"Name Filtering"` section and select the`"Enable Name Filter"` toggle 4. Select the action to take when identifying a user who is joining a chat with your banned name in the `"On Join"` drop down. We recommend a `Kick` or `Ban`. 5. Select the action to take when identifying a user who is messaging in your chat with a banned name in the `"On User Message"` drop down. We recommend using a `Kick` or `Ban`. 6. Add a list of disallowed names using single key words. We recommend names like "Support" / "Bot" and "Admin" 7. Add more rows to the list to provide more names you wish to filter on by clicking the `"Add More Filters"` button. 8. Click the `"Save Changes"` button ### Remove Idle Users Modr8 tracks when users are participant in your chat. This means, they are answering polls/quizzes, they are joining or leaving or they are sending messages to your chat. This is different to the "active" state that telegram shows. We can only track when they are "participating".\ \ Some communities want to ensure there is ongoing active engagement. Modr8 will allow you to remove users who are not engaging within a define period of time and will kick them from the chat if they do not meet the criteria. These users are free to re-join as this is not a permanent ban.

Keeping your chat clean from users who are not actively participating can ensure your community remains engaging

To enable removing non-participating / inactive / idle users complete the following steps. 1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"User Filters"` card 3. Scroll down to `"Remove Idle Users"` section 4. Turn on`"Enable Idle Removal"` toggle 5. State the time period to check for in the `"Idle Time"` input box and drop down. We recommend 12 hrs to 2 days. 6. Set the outcome you want, either the users will be kicked (non-perm ban) or banned (permanent). 7. Click the `"Save Changes"` button ### :question:FAQ & Troubleshooting
Do my admins or whitelisted/trusted users get removed by the idle kicker? No - we specifically filter these users out of the potential kick/ban list. Your trusted and admin users will not be removed by enabling this setting.
Users are being removed from my chat even if they are not idle This is usually due to the understanding of what an "idle" user is. Modr8 does not receive updates from telegram on whether a user is being active in another chat that it is not moderating. Modr8 can only track what it can see, which is users participating in the chats it is monitoring.\ \ For this reason, a user may be chatting in private or another group Modr8 is not part of and Telegram will report to normal apps/clients that the user was last seen today. But Modr8 has not seen them today in the chat talking or participating and therefore will remove them.
Modr8 is not removing idle users if they have been in my chat for a long time In order to remain fair, we only start monitoring the X period of time you have stated since turning on the Idle User kicker module. This ensures we do not remove people who may have been in the chat and not seen the update you have made and get removed. Modr8 as all Telegram bots is unable to see the list of users who were in the chat prior to joining/being added to the chat. This means we may not even know some users exist idle in your chat to start with.
# Timeline & Event Log Telegram typically only keeps actions taken in your chat for up to 48 hours and is only available for admins to review. \ \ In order to extend the possibility as well as audit the events happening in your chat Modr8 supports a chat timeline which last for up to 6 months.

Example timeline hosted on the Modr8 platform showing actions users are taking in your community

In addition to this timeline Modr8 also supports the possibility for an "Event Log Chat" to be connected. This type of chat is typically private for your moderation team. The bot will then log events and actions it is taking into the event log chat and your team can even moderate from this centralised log rather than needing to take action directly in the chat.

Modr8 Event Log Within A Private Admin Chat

The Modr8 linked event log is very powerful and provides the ability for your community moderators to log: * New users joining your chat * Users leaving your chat * Users who have been banned * Users who have been warned * Users who have been kicked * Users who have been muted * Community reported messages using our reporting module * Filtered content * Achievement of new reputation levels You are able to pick and choose which events you log to your moderation chat, as well as amend how messages are displayed with the following settings available: * Show filtered content messages that you can then approve to send back to chat * Display moderation buttons so you can quick ban, warn, mute or trust users * Silence moderation actions you take ### How to view the Chat Timeline * Log into the Modr8 Platform * Select `"Manage"` on your bot profile * Scroll to your chat profile and select the `"Timeline"` button ### Setup The Chat Event Log In order to setup the chat event log, you will first need to carry out some steps on telegram and then some on our platform.

Connecting your event log chat can be done from the timeline page

1. Create a new private group with yourself and any admins you want to moderate with you 2. Add your Modr8 bot as an admin to the chat. You do not need to /activate this chat. 3. Log into the Modr8 Platform 4. Select `"Manage"` on your bot profile 5. Scroll to your chat profile and select the `"Timeline"` button 6. Select the `"Connect Log"` button 7. You will be shown a page that contains a command with `/eventlog <>` 8. Copy the `/eventlog` command and the unique code that comes with it, paste it into your private moderation group. Your bot will respond `"Event log enabled".` 9. The event log web-page will update to show you the event options you can pick and choose from ### Configure Event Log Settings

A full list of configuration options for the eventlog reporting

The eventlog configuration page is split into two areas. The first being which events you wish to report to your moderation chat and then the second being the options about what can be done with those events once reported. We recommend turning on the following events: * New user * User Warned * User Banned * Reported Messages * Reported Messages These events will give you a good view of what the bot is doing and how the chat is behaving. We also recommend to turn on: * Show filtered content - to be able to see messages that the bot has removed * Display moderation buttons - to be able to take quick action on users based on the reported events. All of the above settings can be accessed and amended by completing the following steps: 1. Log into the Modr8 Platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select the `"Timeline"` button 4. Select the `"Edit"` button on the `"Manage Event Logs"` card 5. Select the toggles you wish to adjust on the event log page 6. Click `"Save Changes"` ### :question:FAQ & Troubleshooting
My bot is reporting events in my main chat This happens when you have run the /eventlog command with the unique code in your main chat and not in a new private group with yourself and other moderation admins.\ \ Disconnect the current log by completing these steps: 1. Log into the Modr8 Platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select the `"Timeline"` button 4. Select the `"Edit"` button on the `"Manage Event Logs"` card 5. Click the "Remove Chat" button to disconnect You can now re-run the /eventlog command in your private group with its unique code to connect up the correct one.
# User Management Being able to view who has been in your chat, their current status and other meta data is important for managing your community outside of Telegram. Modr8 has its own user management module and can provide information related to your users such as: * Total tracked user * Number of Trusted, Warned or Banned users * Reputation amounts, Language used, When Joined and When Last Active As well as this, we allow you to manage these users direct on our website and if you like, you can view further profile information for each users and get into the detail of their message sentiment and track their number of messages sent over time. {% hint style="info" %} Due to limitations in Telegram bots not being able to view the full list of chat users we simply track users by their activity in your chat. This includes when a user joins, leaves, messages or votes on a poll. {% endhint %} ### Accessing The User Management Console The user management console allows you to search, filter and export all of the tracked users in your chat.

The user management dashboard allowing you to view who has been tracked within your group and take action

1. Select `"Manage"` on your bot profile 2. Select `"Users"` on your chat profile 3. You are able to click the coloured boxes at the top of the page to quickly filter for those users ### Managing Tracked Users

Execute quick moderation actions on users using the "Manage" button against their profile

Beside each listed user in your tracked user management page you will see a `"Manage"` button. Clicking this button lets you execute quick actions. ### Viewing User Profiles

User Detail

You may wish to view the details of a users profile. This shows you the up to date information we hold as well as allows you to "Manage" the user within the chat. To view the detail of a users profile. 1. Select `"Manage"` on your bot profile 2. Select `"Users"` on your chat profile 3. Search for a user 4. Click the `"Manage"` button at the end of the row 5. Click `"View Profile"` within the menu {% hint style="info" %} If a user has been referred by someone else to your chat, you will also see the user id of this referral. You can click that ID to see the parents profile. {% endhint %} ### Editing User Profiles & Details

Amending user profiles via the user management profile page

It can be useful to edit a users reputation points in bulk, remove a ban or adjust/view their warnings. The user editor card will allow you to view and make these amendments as needed. 1. Select `"Manage"` on your bot profile 2. Select `"Users"` on your chat profile 3. Search for a user 4. Click the `"Manage"` button at the end of the row 5. Click `"View Profile"` within the menu 6. Amend reputation points by editing the number value in the `"Reputation"` text box 7. To add a user to the trusted list where they bypasss bot filters or to remove them toggle the `"Whitelisted"` option 8. The user status can be amended by updating the drop down on the `"Status"` option 9. To add or remove warnings use the `"Add Warning"` button or delete out any you do not want to be in place. 10. Hit `"Submit"` button to save any changes made ### Viewing & Managing Reputation History

View a particular users chat reputation history

Whilst many users have reputation rankings, you may want to drill into a specific user and see how they obtained all of their reputation points. As long as the Community Reputation module is enabled you can view their history on their profile page. 1. Select `"Manage"` on your bot profile 2. Select `"Users"` on your chat profile 3. Search for a user 4. Click the `"Manage"` button at the end of the row 5. Click `"View Profile"` within the menu 6. Scroll down to the `"Reputation History"` section 7. You can delete or copy the history by using the grey buttons as well as search for a particular user ID. Clicking on a username will take you to the reputation givers profile. ### Viewing & Managing Referral History

Auditing user referral history

When running a referral campaign there will always be some users who storm through the rankings and at the end of a competition you may wish to audit who referred who and how it happened. Modr8 user management module contains a full referral history. On the users profile if the referral module is enabled you will see a table containing the users referrals. If you wish, you can delete out any referrals you do not want to be counted, you can also click the "Manage" button to view the users profile that was referred and take any further action. 1. Select `"Manage"` on your bot profile 2. Select `"Users"` on your chat profile 3. Search for a user 4. Click the `"Manage"` button at the end of the row 5. Click `"View Profile"` within the menu 6. Scroll down to "`User Referrals"` section. 7. Select to delete a user referral or click manage to view the referred users profile. ### :question:FAQ & Troubleshooting
Why does the number of tracked users differ from the number in my chat Telegram bots are unable to view the list of users in your chat. We have to track users based on actions and activity they take. Whilst we are able to see people joining and leaving, sometimes telegram also deletes users or they delete themselves. These deletions do not send out any events and are unable to be tracked by us. Instead of claiming to offer an exact representation of your chat member list, instead we are offering the ability to simply ensure we track who is being active and when they were active.
I do not see a referral management section in the users profile page Ensure you have enabled the referral module in your chat settings page. You can read more about how to [enable this here.](/features/community-referrals)
# Announcements Modr8 supports sending announcements out to your communities on a one-off basis or scheduled, including at specific intervals. The following sections will explain in detail on how to send out your first announcement as well as how to deal with complex scheduling scenarios where you want to send at a specific time and end at a specific time. In addition to standard announcements the Modr8 engine is able to integrate with social channels and feeds to provide near real-time updates. Our social announcements will keep your community up to date with the latest news and posts without having to manually send these notifications out. Check out the options for our announcements using the page links below: {% content-ref url="/pages/6oe11e6LLTFHcNe03Wid" %} [One-Off & Scheduled](/features/announcements/one-off-and-scheduled) {% endcontent-ref %} {% content-ref url="/pages/M0fwsMhgaSXyg1XkUJAH" %} [Social Announcements](/features/announcements/social-announcements) {% endcontent-ref %} {% content-ref url="/pages/dF92etNYtoZXaXTNkz8l" %} [Global Bot Announcements](/features/announcements/global-bot-announcements) {% endcontent-ref %} # One-Off & Scheduled ### Sending An Immediate / One-Off Announcement When you wish to quickly distribute news via the Modr8 Platform you can use the one-off / immediate announcement builder. This lets you send a message which contains rich text as well web links, commands and action execution buttons.

Immediate announcement builder

To issue an immediate announcement complete the following steps: 1. Select `"Manage"` on your bot profile 2. Select `"Announce"` on your chat profile 3. Select `"Create Announcement"` button on the `"One-off Announcement"` card. 4. Add your content using the `"Content"` area 5. Add any buttons by clicking the `"Message Buttons"` button. 6. A direct image link can be added if the address ends in .jpg, .gif, .png or .mp4. You can also upload a file into your chat and reply to the message with /fileid this will produce a long string of text which can be pasted into the Image text box too 7. Elect to `"Pin Message"` if you want the message to be stickied to the top of the chat once issued 8. Click `"Submit"` to send ### Sending A Scheduled Announcement You may wish to schedule an announcement to be sent at a later date, as well as have it send on an interval basis every x amount of time. We can also use the Modr8 engine to stop the message being sent at a specific time/date. For all of these use-cases we use the scheduled announcement builder module. The builder is made up of 3 segments, we will show you how to use each section in the following sections.

Schedule annoucement header information

1. Select `"Manage"` on your bot profile 2. Select `"Announce"` on your chat profile 3. Select `"Manage Announcements"` on the `"Interval & Scheduled Announcement"` card 4. Click `"Create Announcement"` to begin building a scheduled announcement 5. Start by providing a name for the announcement in the `"Name"` field. This shows up on your list of scheduled announcements so you can easily edit or delete it later. 6. You can leave the `"Active"` toggle enabled, this is useful later if you wish to turn your announcement off and re-use it again another time. 7. Elect to `"Pin Message"` if you wish. When using scheduled announcements it will be re-pinned each time it is sent. This is useful if you have rotating content you wish to pin. 8. Elect to enable the `"Remove Last Message"` option. This ensures the bot will clean up the previous announcement and keeps your chat nice and tidy. That's it for this section - the main thing is to ensure you have a name for the announcement you will recognise later. We have some communities running 10's of scheduled announcements through the year so its useful to be able to spot the ones you wish to turn on or off. In the following section, we will discuss adding your content and being able to rotate content each time an announcement is sent.

Scheduled & Interval announcements can have multiple content sets which are rotated on each interval

1. Begin by adding your message content into the area marked `"Text"`. You can use the buttons above the editor to make text bold, italic, strike-through, code as well as add emojis and links. 2. Add an image web link or fileid into the `"Image"` input box. A file id can be obtained by uploading your media to your chat (with the bot in) and replying to it with the command `/fileid` 3. Elect to add any buttons to your message by clicking the `"Message Buttons"` button. This allows web links, commands and actions to be executed from button clicks attached to the announcement 4. Click `"Add More Content"` if you wish to add another message and begin the process again {% hint style="success" %} For each content added using the "Add More Content" button your bot will send the next content in the queue after each interval. This is a great way to have 1 scheduled announcement that contains multiple content blocks which rotate sending through the day. {% endhint %} Next we will move onto scheduling your announcement using the schedule section. This offers a powerful set of options from being able to select which content is sent first through to starting and ending your announcement on specific dates & times.

Modr8 scheduled announcements can be started and stopped at specific times.

1. Scroll down to the `"Schedule"` section 2. By default `"Content 1"` will be shown, but if you have multiple content created you can select a different one to send first by amending the drop down 3. Set an interval to send your announcement over by amending the `"Send Every"` X to a value you wish and the drop down to a period you wish e.g. hours or days. 4. Set whether you wish to `"Start Sending"` immediately or later. 5. If selecting to start sending later, add a date/time in the `"Schedule for"` input by clicking inside and using the calendar. 6. Set a `"Stop Sending"` date/time by clicking in the input area and completing the calendar. 7. Click "Submit" to set your announcement. If you have selected to send `"Immediately"` then it will begin sending. **Note:** Times and dates used in the `"Schedule For"` and `"Stop Sending"` inputs are based on your local timezone. Modr8 will convert this to send at the correct times for its location using this information. {% hint style="info" %} If you do not wish to continually send your announcement, simply set your "Send Ever" period to be bigger than the gap between Schedule For and Stop Sending times. \ \ **Example:** Schedule for 1pm today, Stop Sending 2pm today. Interval 1 day. Will send once and stop before executing the next interval. {% endhint %} ### Managing Scheduled Announcements

Scheduled announcements you have created will be listed on the scheduled announcement page for quick management

Once you have created a scheduled announcement it will show up listed in the scheduled announcement table on the scheduled announcement page. Here you will be able to see the name, interval it is due to send on, the next time it is due to execute as well as whether it is active or not. From this table you are able to: * Toggle whether the announcement is active or not to quickly activate or de-activate it * Click the pencil button to edit your announcement * Click the red trash bin button to quickly delete your announcement ### :question:FAQ & Troubleshooting
I have scheduled announcement but what Timezone does it use? When creating announcements the date/time picker will translate to your local time. This means you should set your scheduled based on what you would like to see in your timezone. The modr8 engine will transform this in the background to UTC timezone and issue the announcements at the expected value you set. If another admin were to go to your scheduled announcement, they would see when it is expected to send for THEIR timezone. This means you are all aware of when it is expected to send for the region you are in.
The spacing of message text is not correct when being sent, but it looks fine on the site. Sometimes we have found people paste content into their message area which can cause spacing issues with the editor we use. Delete all of the content out of the are and re-add it. If you still suffer issues with this let us know in our support chat. We are actively looking for bugs in the editor as there are many different keyboard setups people use that we wish to cater for.
# Social Announcements ### Supported Social Announcement Feeds

Modr8 Has The Most Comprehensive Social Announcement Integrations

The Modr8 engine supports social integrations that will announce new posts into your chat when they are made in near real-time. At present the following are supported: * Twitter/X.com * Zendesk * YouTube * Medium * RSS * Twitch We are actively adding further integrations, if you have any other social platforms you would like to see drop us a message in the feature ideas community topic on Telegram. ### Connecting Twitter / X Announcements Our twitter/x.com integration will check for new tweets on accounts every few seconds.

Connecting Twitter/X.com feeds to your telegram chat with the Modr8 bot engine

1. Select `"Manage"` on your bot profile 2. Select `"Announce"` on your chat profile 3. Select `"Manage Announcements"` button on the `"Social Media & Feeds"` card. 4. Select `"Link Twitter"` on the Twitter card 5. Add a name for your feed in the `"Name"` field, this helps to identify it amongst other feeds you may link when wishing to manage your list of announcements. 6. Add the Twitter/X.com username you wish to follow, this is done without the @ i.e `@ImTheDeveloper` should be added as `ImTheDeveloper` 7. Elect to enable showing retweets by toggling the `"Display Retweets"` option 8. Elect to enable showing quoted tweets by toggling the `"Display Quoted Tweets"` option 9. Elect to enable showing replies to tweets by toggling the `"Display Reply To Tweets"` option 10. You can remove the last tweet issued by this announcement by enabling the `"Remove Last Message"` option 11. Keep the `"Active"` toggle enabled if you wish for this feed to be actively searching for new tweets. 12. Click the `"Submit"` button and you are ready to go! ### Connecting Zendesk Announcements Use the Modr8 Zendesk announcements integration to post announcements into your chat when a new article is released on your Zendesk instance.

Connecting Zendesk new article feeds to your telegram chat with the Modr8 bot engine

1. Select `"Manage"` on your bot profile 2. Select `"Announce"` on your chat profile 3. Select `"Manage Announcements"` button on the `"Social Media & Feeds"` card. 4. Select `"Link Zendesk"` on the Zendesk card 5. Add a name for your feed in the `"Name"` field, this helps to identify it amongst other feeds you may link when wishing to manage your list of announcements. 6. Add the Zendesk Article API EndPoint into the input text box. The format of the EndPoint is typically: `https://xxxx/api/v2/help_center/lang-code/articles.json` you will need to replace xxxx with the domain. 7. Elect to enable the `"Remove Last Message"` to ensure only the newest Zendesk announcement is shown if you do not want too many announcements in your chat 8. Keep the `"Active"` toggle enabled if you wish for this feed to be actively searching for new Zendesk articles being published. 9. Click the `"Submit"` button and you are ready to go! ### Connecting YouTube Announcements If you want to publish the moment a new YouTube video is added to a channel you can use the Modr8 YouTube Announcements module.

Connecting YouTube new video feeds to your telegram chat with the Modr8 bot engine

1. Select `"Manage"` on your bot profile 2. Select `"Announce"` on your chat profile 3. Select `"Manage Announcements"` button on the `"Social Media & Feeds"` card. 4. Select `"Link YouTube"` on the Youtube card 5. Add a name for your feed in the `"Name"` field, this helps to identify it amongst other feeds you may link when wishing to manage your list of announcements. 6. Add a Channel ID to the `"Channel ID"` input field. This can be found by following the instructions on screen or using a service like: the ID is not the username, as these can change. 7. Elect to enable `"Pin Announcement"` if you wish new videos to be pinned as they are posted 8. Elect to enable the `"Remove Last Message"` to ensure only the newest Youtube announcement is shown if you do not want too many announcements in your chat 9. Keep the `"Active"` toggle enabled if you wish for this feed to be actively searching for new Youtube Videos being published. 10. Click the `"Submit"` button and you are ready to go! ### Connecting Medium Blog Announcements With our social announcements you are able to post a new announcement to your chat when a medium profile has a new blog published to its profile.

Connecting Medium new publications to your telegram chat with the Modr8 bot engine

1. Select `"Manage"` on your bot profile 2. Select `"Announce"` on your chat profile 3. Select `"Manage Announcements"` button on the `"Social Media & Feeds"` card. 4. Select `"Link Medium"` on the Medium card 5. Add a name for your feed in the `"Name"` field, this helps to identify it amongst other feeds you may link when wishing to manage your list of announcements. 6. Add the `"Medium Blog Username"` to the input field. This is the end part of the web address used for the blog. 7. Elect to enable the `"Remove Last Message"` to ensure only the newest Medium blog announcement is shown if you do not want too many announcements in your chat 8. Keep the `"Active"` toggle enabled if you wish for this feed to be actively searching for new Medium blog posts being published. 9. Click the `"Submit"` button and you are ready to go! ### Connecting RSS Feed Announcements Modr8 engine suports posting announcements based on RSS feeds. This is a very versatile option as most blogs and websites have some sort of RSS feed you can use. If not, there are even websites available that will convert standard sites into RSS feeds for you.

Connecting RSS feeds to your telegram chat with the Modr8 bot engine

1. Select `"Manage"` on your bot profile 2. Select `"Announce"` on your chat profile 3. Select `"Manage Announcements"` button on the `"Social Media & Feeds"` card. 4. Select `"Link RSS Feed"` on the RSS Feed card 5. Add a name for your feed in the `"Name"` field, this helps to identify it amongst other feeds you may link when wishing to manage your list of announcements. 6. Add the `"RSS Feed Endpoint"` to the input field. This may be a web address ending in /feed/ or some other address that ends in .rss 7. Elect to enable the `"Remove Last Message"` to ensure only the newest RSS feed announcement is shown if you do not want too many announcements in your chat 8. Keep the `"Active"` toggle enabled if you wish for this feed to be actively searching for new feed posts being published. 9. Click the `"Submit"` button and you are ready to go! ### Connecting Twitch Stream Announcements Knowing someone is going online with Twitch can be a great way to grow your gaming or code development community. Modr8 receives real-time updates from twitch to let you know someone has gone online.

Connecting Twitch Streams to your telegram chat with the Modr8 bot engine

1. Select `"Manage"` on your bot profile 2. Select `"Announce"` on your chat profile 3. Select `"Manage Announcements"` button on the `"Social Media & Feeds"` card. 4. Select `"Link Twitch"` on the Twitch Feed card 5. Add a name for your feed in the `"Name"` field, this helps to identify it amongst other feeds you may link when wishing to manage your list of announcements. 6. Add the `"Twitch Account Username"` to the input field. This will be the username without the @ added to it. 7. Keep the `"Active"` toggle enabled if you wish for this feed to be actively searching for users going online. 8. Click the `"Submit"` button and you are ready to go! # Global Bot Announcements Modr8 supports Global & Multi-Chat Features. This includes, the ability to send an announcement as a one-off broadcast or scheduled and on an interval. The same functionality you have in a single chat, we also have at the global bot level. When you send a Bot Announcement, all of the chats activated under that bot will receive the notification. This is a great way for spreading news as well as uniformly issuing information out to all of your chats. You can read more about our [multi-chat and global features here](/introduction/global-and-multi-chat-features), but hopefully this diagram helps to explain the setup too.

Any chat registered to the same bot can have global bot announcements sent to it

Multi-chat features are accessed using the "Bot Menu" as show in the image below.

Accessing the "Bot Menu" opens up the global bot announcement option

### How To Send A One-off Global Announcement The instructions here are very similar to sending a one-off chat announcement with the main difference being you access bot level announcements via a different menu. 1. Login to the platform 2. Click `"Manage"` on your listed bot 3. Click `"Bot Menu"` to open up the bot level menu options 4. Click `"Bot Announcements"` 5. Select the `"Create Announcement"` button on the `"One-off Announcement"` card 6. Add your message content, utilising the formatting buttons available such as bold, italics and strike-through 7. Add any buttons you wish to be sent such as links, command buttons and action buttons by clicking the `"Buttons"` button. 8. If you have an Image you wish to send add a web-link to it ensuring it ends with .mp4, .png, .jpg or .gif 9. Elect whether you want the message to be pinned to the top of your chat once sent by enabling the `"Pin Message"` toggle 10. Click `"Submit"` and your message will be sent out to each of the chats your bot is activated in. ### How To Send A Scheduled / Interval Based Global Announcement Being able to send a scheduled / interval based announcement will allow you to continually issue content into all of your activated chats. 1. Login to the platform 2. Click `"Manage"` on your listed bot 3. Click `"Bot Menu"` to open up the bot level menu options 4. Click `"Bot Announcements"` 5. Select the `"Manage Announcements"` button on the `"Interval & Scheduled Announcement"` card. 6. Click `"Create Announcement"` on the `"Interval & Scheduled Announcement"` card. To build out this announcement please follow the same instructions of the [announcement builder found here.](/features/announcements/one-off-and-scheduled#sending-a-scheduled-announcement) You will manage these announcements in the same way as your chat level announcements, with the only change being you access these through the `"Bot Announcement"` menu. ### :question:FAQ & Troubleshooting
The global announcement did not send to X chats This can be due to a couple of reasons and it is worth checking the following: * Your bot is an admin of the chat and has the ability to send messages * You have an active subscription for the chat * Your bot has not been rate limited for sending too many messages by Telegram. We attempt to manage this for you though!
# Polls & Quizzes Modr8 bot engine supports issuing native Telegram polls, quizzes and anonymous quizzes. Whilst it can be hard to track responses (including timestamps of responses given) via Telegram analytics the Modr8 platform offers full management via our Platform pages.

Polls & Quizzes issued by the Modr8 platform show real-time responses

Modr8 tracks the time stamp of responses being given so you can be sure to know who responded to your poll/quiz as well as WHEN they responded.

### Supported Polls & Quiz Types At present Modr8 can issue polls with the following features. * Up to 10 options for an answer * Ability to send as Quiz with selection of which of the 10 options is the right answer * Ability to issue the Quiz or Poll as anonymous so users who have responded are not shown on Telegram * Scheduled publishing of polls/quizzes * Scheduled closing of the polls/quizzes ### How to create & issue a Polls & Quizzes

Add in a poll question and potentially up to 10 answers users can provide responses to

You can configure multiple options in a Modr8 poll and even turn it into a quiz that is scheduled to send and close automated.

To issue a poll or quiz then complete the following steps: 1. Select `"Manage"` on your bot profile 2. Select `"Polls"` on your chat profile 3. Select `"Create"` button on the `"Create A Poll or Quiz"` card 4. Provide a poll `"Question"` which will be the main body of the poll. This is limited to 300 characters by Telegram. 5. Provide answer options, a minimum of 2 are allowed and a maximum of 10. To add more potential answers click the `"Add More"` button 6. Elect to send the poll as a quiz by enabling the `"Send As Quiz?"` toggle 7. Elect to allow users to provide multiple responses by enabling the `"Multi-response?"` toggle. **Note:** You can not have a multi-response quiz. Telegram does not support this. 8. If you want users to record responses anonymous then enable the `"Anonymous?"` toggle. 9. If you want to open and close the poll based on a schedule you can enable the `"Enable Schedule?"` toggle 10. Set a `"Schedule Publish"` date and time by clicking the calendar icon at the end of the input box 11. Set a `"Schedule Closing"` date and time by clicking the calendar icon at the end of the input box 12. You can choose to `"Publish Poll"` immediately or if you want to come back later you can click the `"Save Draft"` button to re-edit it later ### Managing & Tracking Polls & Quizzes When a poll has been created, drafted or closed it will show up on the main poll management page. From here you can select to view responses, close the poll or edit drafts. Within each of the sections below you will provide a brief overview of the functionality that is available on the poll management page dependent on the state that your poll is currently in.

Example draft poll that can be edited

Polls which are set in the draft state can be edited by any administrastor. Saving a poll as a draft is useful if you are planning to make changes at a later date.

Example scheduled poll which can be edited

If you have elected to issue your poll in the future, using the scheduled opening time you can make changes to the poll by clicking the `"Edit"` button up to the moment it is published.

A poll has been issued and is now being tracked by Modr8

Once a poll has been published to your chat or channel you have the options to: * View the responses given in more detail including viewing the users and timestamps their vote was given * View the poll direct within your chat * End the poll and close it on Telegram. It will remain visible but chat users can no longer provide responses

Closed polls keep their data so you an review responses easily

Once a poll has been closed you can: * View responses to see the totals received for each poll option as well as timestamps and respondent data * View the poll by jumping to the message on your Telegram app/client # Analytics The bit every community manager wants to see.. analytics and reporting! Modr8 platform using your community bot will track messages and events within your chat. Every 15 minutes these events are aggregated into hourly and daily measures to produce a series of charts and stats that will give you a view of how your community is behaving and growing.\ \ We're showing a few graphs below, but continue to scroll on to see a table which provides the stats we measure and a description of what they are created for / from. To access the Modr8 analytics page for your chat complete the following steps. 1. Select `"Manage"` on your bot profile 2. Select `"Analytics"` on your chat profile 3. Set a `"Start Date"` 4. Set a `"End Date"` 5. Click the `"Search"` button to update the charts and stats

Modr8 provides ongoing tracking of user movements in and out of your community as well as messages being sent

You might want to know when your busiest day or even hours are within the community to provide insights on when best to send announcements or have more coverage from community managers.

The table below outlines the metrics and measurements you will find on our analytics page. | Name | Type | Report Description | | ---------------------- | ------ | ------------------------------------------------------------------------------------------------------ | | Messages | Stat | Total number of messages in the period | | Joining Users | Stat | Total number of users joining the chat in the period | | Leaving Users | Stat | Total number of users leaving the chat in the period | | Active Users | Stat | Total number of users who have engaged in the chat in the period | | Avg. Messages | Stat | Average number of messages per day in the period | | Max Active Hour | Stat | Hour with the most events & messages in the period | | Chat Messages | Report | Number of messages tracked per day/month in the period | | User Movement | Report | Number of users joining, leaving and growth per day/month in the period | | Message Sentiment | Report | Average sentiment recorded for messages recorded per day/month in the period with max +2 and min -2 | | User Message Languages | Report | Telegram Client reported user language per message within the period | | Warnings Issued | Report | Total number of warnings issued per day/month within the period | | Bans Issued | Report | Total number of bans issued per day/month within the period | | Active Days | Report | Total messages sent per named day within the period | | Active Hours | Report | Total messages sent per individual 24 hour within the period | | Popular Commands | Report | Number of times a command was executed within the period | | Top Active Users | Report | Number of messages/events issued by a user within the defined period limited to top 10. | | Popular Media | Report | Total number of messages sent by media type within the period | | Message Media | Report | Messages split by media type per day/month within the period | | Open Referrals | Report | If referral module is enabled, shows the total number of invites issued within the defined period | | Closed Referrals | Report | If referral module is enabled, shows the total number of completed referrals within the defined period | ### :question:FAQ & Troubleshooting
Why do my user join / leave stats not equate to the same as I see in my chat logs? Telegram only sends a subset of information through to Telegram bots. When a user leaves your chat due to deletion or banned for spamming by telegram themselves we do not get such an update. \ \ This is why there can be discrepancies in the data for number of users moving around. We would take the stats as a general measure of your trends, rather than an absolute.
# Actions Modr8 Actions let you build out simple to highly complex rules & conditions which will then output an action to be taken by your bot.\ \ Think of actions as a "If this happens, then do that" type of rule engine. There are thousands of actions you can create, you can even create sets of multiple conditions to be met for an action to be executed. To give an idea of the type of conditions you can work with, we can trigger an action based on: * User profile attributes * Message attributes * Types of media sent * Games being sent * Messages being received at set times * Premium member properties * Text patterns * And much much much more!

Multiple action conditions being shown to filter down when the action outcomes will be run

Once an action has had its conditions met, then you can create either a set of actions to be taken by your bot or even create groups of actions which can be randomly selected. Maybe you want to issue some reputation at random to users plus send out an animated image. Maybe you want to respond to users in a specific language or build out your own set of moderation commands that can be used by only users you specify. All of this is possible and much more. To provide a list of potential actions that can be taken we've listed out just a few below: * Send a message with personalisation * Delete messages * Send an image or file with a caption * Mute / Ban / Amend reputation * Pin messages * Silence / Un-silence the chat * And much more!

Modr8 action first deleting a users message and then sending a personalised message to the chat explaining why

If you want to find some pre-build Actions why not checkout our[ "Action Marketplace" ](https://platform.modr8.net/member/actions)where some of the best Actions have been listed from our community.
# Quick Start The quickest way to get up and running with Actions is to just have a go! The following sections will outline how to create your first action using a simple "Hello World" style command. We want the command to run when a user sends a command such as !hello or /hello with the output being "Hello X, how are you?" ### Creating An Action 1. Login to the Modr8 platform website 2. Select `"Manage"` against your bot profile 3. Select the `"Actions"` button on your chat profile 4. Click the `"Create"` button on the `"Create A New Action"` card 5. Provide a name for your action so it is easier to find later by adding it to the `"Strategy Name"` text box 6. `"Executes For"` allows you to change permissions of when the action will run, we will leave it as is for now. 7. `"Active"` is a switch to turn the action off or on, leave this enabled 8. `"Execution Probability"` is a % chance for the action to be run on every event received. Leave this as 100%

Header information added in for our Hello World example

Now that the main header information of the action is set up we will move on to adding in conditions. ### Adding Conditions Conditions define what must happen for the action outcomes to run. In our Hello World example we want it to run when a message is sent to the chat that starts with !hello or /hello. 1. In the `"Property"` drop down select `"Message Text"` as we want to match message text 2. In the `"Match"` drop down select `"Starts With"` as we want to match the start of a message 3. In the `"Match Value"` text box add the text `/hello` 4. Click `"Add Condition"` button as we want to add another condition for the command to run 5. Complete steps 1 -3 again in the new condition that opens up but add `!hello` to the `"Match Value"` this time. 6. Switch the drop down that says `"Match All Conditions"` to read `"Match Any Condition"`

Conditions to execute our Hello World command are added in

Now we have defined some conditions for our action to run which are when a message is sent to the chat that starts with "/hello" or "!hello" ### Adding Action Outcomes When the conditions are met, we said we wanted to issue a message to the user. We will now begin adding the text in using our action outcomes. 1. Scroll down to `"Action Groups"` 2. In the `"Execute Action"` drop down select `"Send Message"` 3. In the `"Message Text"` area that opens up add `"Hello {{o_user}}, how are you?"` 4. Check the tick box `"Delete After Timeout"` 5. Click `"Save Changes"`

Creating our Hello World command action to send a message to the user

In your chat with your bot you should now be able to send either /hello or !hello and see your action running.

Running our Hello World example command built using Modr8 actions

In this tutorial we have simply replicated what our command module can already do, but hopefully with all of the various options you have seen it is apparent how much customisation you can do! Actions are a great way of solving the complex use-cases every community has where Modr8 does not have a generic setting you can use actions to do exactly what you need. # Conditions Conditions are used to define when your actions will run, they are the rules that need to be passed to continue execution. ### Condition Groups Conditions are contained within a condition group. When adding multiple conditions to a group the overall group needs to be "passed" before running your action. You are free to add multiple groups and when you do, the outcome is based on "OR MATCH CONDITIONS" convention. This means if you have multiple groups of conditions only one of those groups needs to pass for your action to run. You will use condition groups to split up complex rules/conditions and make them easier to understand and debug if you face any issues.

Modr8 Conditions & Condition Groups

### Condition Options Conditions are based on "Properties", the very first item you will select for a condition is the "Property" drop down. From here, dependent on the condition selected the "Match" will adjust as well as the "Match Value". These allow you to be super specific on what you want your rule to run against and what it should be checking for.

Some condition properties will require a match type and a match value to be specified

Some condition properties only require a simple yes or no match

The property type groupings Modr8 supports you building rules against are specified in the table below. | Property | Description | | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Message Properties | Conditions & properties that are related to a message. This could be the text of a message, whether it is a reply to another user or whether it is a forwarded message | | Originating User Properties | The originating user is the user who caused the event to happen that Modr8 engine is running its rules against. This could be the person who just sent a message, it could be the user who just joined the chat. You can create matches against the properties of this user such as their username or user id. | | Chat Events | These are specific events emitted by the Chat group itself, also known as "Service Messages". These happen typically when a user joins or leaves your chat. | | Media Messages | A sub type to the Message Properties, media messages are very varied so we have created a section just for them. If you want to match against "Media" or maybe specific properties of a video or dice roll game you can do so by using this. | By combining multiple types of condition with multiple types of property checks you can see how we can easily build out very broad or very narrow rules and conditions to execute actions. ### Managing Action Group Conditions As discussed in previous sections, an action group can contain many conditions and you are able to have multiple condition groups within your action builder. When you have multiple condition groups these work with an "OR" condition between them. This means the Modr8 action engine will attempt to match condition group 1 OR condition group 2 OR condition group X. If any of these groups match successfully then your action will run. But what if you wish your conditions WITHIN a condition group to also match with an "OR" condition? Well, by default you will have noticed when adding multiple conditions to a condition group you see ---- AND --- between them as per the following image.

Multiple conditions within a condition group, where all of them must match due to the "Match All Conditions"

You will notice in the header of the group it says "Condition Group 1" followed by a drop down stating "Match All Conditions". This is saying all of the conditions within my group 1 must match for this group to be a true match.\ \ We can switch that drop down to "Match Any Condition" and we will now have an "---- OR ----" show between the conditions. This means I want any of the following conditions to be true and then if so my overall group is a true match to run my action.

Condition group set for any condition to be a match giving us the "OR" condition match

When is the best time to use "Match Any Condition" vs. Creating a new condition group? Honestly, it is a case by case basis and sometimes you just have to review the use-case you are trying to fulfill. For now, it is good to know you have this option available to you! # Action Groups When your conditions and condition groups have met their rules to provide a true value and execution can continue, we move on to the "Action Groups" and the actions that will then run. The most simple outcome is that a single action will execute, such as being able to send a message and some configuration for how this message will be handled i.e. deleted after a delay or pinned when it is sent.
### Availability Of Actions To Be Run Modr8 supports an array of actions that can be executed, from sending simple messages to being able to execute admin and moderation commands. The table below outlines the current set of options along with a short description of their usage and what they do. | Action | Description | | ------------------- | -------------------------------------------------------------------------------------------------------------- | | Send Message | Issue a message to the chat inc. personalisation options and being able to delay its deletion | | Send Image | Send a photo to the chat based on a file ID or web url. Option to also add a caption to the image. | | Send Video | Send a video to the chat based on a file ID or web url. Option to also add a caption to the video. | | Send Animation | Send an animation to the chat based on a file ID or web url. Option to also add a caption to the animation. | | Send File | Send a file to the chat based on a file ID or web url. Option to also add a caption to the file. | | Send Audio | Send an audio file to the chat baed | | Pin Matched Message | Pin the message that has been matched by the conditions groups. This works mainly for media and text messages. | | Roll Dice | Issue a dice to the chat which can be rolled by users to specify a value. | | Delete Message | Delete the message that has been matched by your conditions. | | Warn User | Issue a warning to the user who has been matched by your conditions. | | Remove User Warn | Remove a warning based on the matched conditions and when a user is targeted. | | Kick User | Kick the user who has matched the conditions in your groups. | | Mute User | Mute the user who has matched you conditions including specifying a duration for the mute. | | Un-mute User | Remove a mute restriction based on the user matching your conditions. | | Ban User | Ban a user with a specified ban duration when matching your conditions | | Global Ban User | Globally ban a user from your bot chats including a duration | | Remove User Ban | Remove a ban restriction based on the user matching your conditions. | | Trust User | Add a user to your trusted whitelist if they match your conditions. | | Un-trust User | Remove a user from the trusted whitelist if they match your conditions. | | Global Trust User | Globally trust a user across all of your bot managed chats | ### Managing Actions & Action Groups As with our conditions, you are able to add another action within this group. By adding another action, you are creating a series of actions which will execute in the order that you have specified. For example, here we will delete a message (the one sent to cause the conditions to run) and then we will send an action to kick the user who sent the message.
Again, as with our condition group, you will notice in the header next to the `"Action Group 1"` we have the `"Run All Actions In Group"` drop-down and between the two actions that are set to run you will see the `"----- AND ----"` notation. This is telling us that the more actions we add to this group, the bot is going to run each of them in turn until completed. As with our condition groups, we also have the option to add new Action Groups. By doing this, we offer a random rotation of which action group set will be executed when our condition rules are matched.

Adding multiple action groups leads to us having an "OR EXECUTE GROUP" condition.

The benefit of having this functionality is that you can randomise the action outcomes, maybe you want to give out random reputation or change an image based on random chance. This is precisely how the Russian roulette game works in our Action Marketplace. ### Special Action Targets You may notice, in our condition rules we are to set the following parameters: * Replies To A User * Mentions A User

Special case conditions which unlock actions that can target different users.

When adding these conditions to a condition group you unlock the ability for your actions to "target" a specific user for action types which involve "moderation"

Target User is now shown as an option against the simple Kick action which was not visible before

Since we have conditions which are concerned with "replied to" and "mentions a" we now have the option to specify the target, which includes: * The originating user - As per the standard action option when special conditions do not exist * The replied to user - The condition has identified a user has been replied to and we want to target that person * The mentioned user - The condition has identified a user has been mentioned in the message and we want to target that person * Either the replied or mentioned user - Combination of both of the above Why is this useful? It means we can produce actions that target users other than the person who sent the message and therefore build out commands that mimick our own moderation commands. Maybe you want to ban a user if they are mentioned, maybe you want to make reputation rain down with a special !rain @user type of command. All are now possible with these options. # Managing, Importing & Exporting Actions Once you have some actions created you will be able to view which are active, edit as well as copy or delete these from the "Actions" page on your chat profile.

Manage your actions from the "Actions" page within your chat profile.

Against each listed action there are a series of options you can use: * **Active:** Toggling the "Active" switch will turn on / off your action without needing to edit each action * **Pencil:** Clicking the Pencil icon will allow you to go into your action to edit it, just the same as when you were first creating it. * **Trash Bin:** The red trash bin will delete the action after confirming you wish to do so via a pop-up message * **Copy:** The copy icon will open up the copy code pop-up. From here you can copy the code presented and store it or paste it into the import area of another chat if you want to share actions. ### Importing & Exporting
As well as being able to manage individual actions you will also see two cards listed beside the "Create Action" card. These cards serve two purposes. * **Importing Actions** - Here you can paste a single action code into the text area OR you can paste a full export of multiple actions into the text area. Upon clicking the import button you will be taken to your action to edit it if you wish * **Export Actions** - As well as being able to use the copy icon beside each of your actions listed you can click the "Export" button on this card to take a copy of all of your actions you have built. This is a great way to take a back up or to export everything to import into a new chat. # Using The Marketplace As actions have been very popular we often get asked about creating a set that can be used by anyone as well as showing examples of more complex actions for people to learn from. We have built the "Action Marketplace" this is a page on our platform which lists popular actions that you can export and import into your own chats. You can access the [marketplace here](https://platform.modr8.net/member/actions) as well as by clicking the "Action Marketplace" link in the top menu of our website:

The action marketplace can be found in our web menu

Each action listed on the marketplace has a brief description outlining its functionality as well as the code you will need to import:

Example action listed on our marketplace.

You can click the "Copy to Clipboard" button and the code will then be available for you to import easily. If you have any actions you wish to share with the community feel free to drop a message in our Telegram chat and we will be sure to get it added! # Bot Actions vs. Chat Actions You may have seen when accessing the "Bot Menu" button that there is an option called "Bot Actions". These are actions which work in Private Message only with the bot and are not the same as chat actions which work within the public chat. We have found some users like to create advanced use-cases within private chats with their bots such as providing commands, key word triggers and sending media. {% hint style="warning" %} You are unable to export / import actions between "Bot Actions" and "Chat Actions" the two are incompatible due to fundamental differences in the functionality between a chat and a private chat. {% endhint %} To create a bot action: 1. Login to the Modr8 Platform 2. Click `"Manage"` on your bot profile 3. Click `"Bot menu"` below the profile image of your bot 4. Click `"Bot Actions"` 5. Click `"Create Action"` From here it is similar to creating chat level actions but you will notice some limitation of options. ### :question:FAQ & Troubleshooting
I am trying to import an action but it is not showing Ensure you are not trying to import an action that was built for a chat. They are not compatible and will not work at the bot level. \ \ Bot level actions will only run in private message with your bot and do not offer the same options.
# Commands Telegram bots for years have been built purely to run commands and with the Modr8 platform we have a set of built-in commands and the ability for you to create and customise your own. Modr8 built-in commands are there to help you manage your bot and your community from within Telegram. If you are looking to issue a warning, ban someone or even promote a user to be an admin you can do this with our built-in commands. We've provided a [full list of them here for you.](/features/commands/built-in-commands) Custom commands are those which you can build with the Modr8 platform. These are a great way for you to offer quick content, news and announcements in your chat for users to self-serve. You can take a look at [how to build a custom command](/features/commands/creating-and-managing-custom-commands) with Modr8 here. If you have a use-case which a command or custom command can not meet, then you'll be glad to know Modr8 can be customised with "Actions", which are "if this happens then do that" type of rules and offers a much larger set of features than a simple command could offer you. Feel free to check out our overview and guide pages here to learn more about [Modr8 Actions.](/features/actions) # Built-in Commands Modr8 registered bots out of the box come with many commands to manage you telegram community.Whether you wish to silence the group, warn a user or globally ban a member across all of your chats you will find a command to meet your needs. The tables below identify the commands available, the access of user that can utilise the command and a brief description. {% hint style="info" %} **Need more help?** Feel free to [join our support chat here](https://t.me/modr8support), to ask any questions and offer suggestions. There is a lot of functionality within the Modr8 platform and you can even create your own custom moderation commands using "chat actions" if you can not find what you are after as standard. {% endhint %} **Usage**\ The command list can be found by privately messaging your bot and typing /commands, if you need to execute a command it should be done in your chat. ### User Commands The following commands can be used for real time user management. You are also able to reply to a user message to invoke the command without needing to use their username or ID. | Command | Description | Access | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | | /promote | Add a user as an admin to the chat. | Admin | | /demote | Remove a user from being a chat admin. | Admin | | /ban | Remove a user from the chat. | Admin | | /unban | Remove a ban from a particular user. | Admin | | /sban | Silently remove a user from the chat. | Admin | | /gunban | Globally remove a ban from a particular user in all chats. | Admin | | /gban | Ban a user across all chats your bot manages. | Admin | | /banlist | View a list of banned users. | Admin | | /kick | Remove a user from your chat (non-permanent). | Admin | | /skick | Remove a user silently from all of your chats (non-permanent). | Admin | | /gkick | Remove a user from all of your chats (non-permanent). | Admin | | /warn | Issue a warn to a user. | Admin | | /swarn | Silently issue a warn to a user. | Admin | | /gwarn | Issue a global warning to a user across all chats. | Admin | | /unwarn | Remove a warning from the users warning count. | Admin | | /resetwarns | Completely wipe any warnings a user has. | Admin | | /mute | Mute a user from sending messages for a period of time. | Admin | | /unmute | Remove the restriction for a user to be able to chat again. | Admin | | /smute | Silently mute a user. | Admin | | /whitelisted | View a list of whitelisted users. | Admin | | /whitelist | Whitelist user so they bypass filters. | Admin | | /gwhitelist | Globally Whitelist a user so they bypass filters across all chats. | Admin | | /unwhitelist | Remove a user from the whitelist. | Admin | | /resetuser | Reset the users platform & telegram bans, warns and mute status. Useful if running into trouble with a user gaining access to your channel. | Admin | | /user | Receive a list of user information including ban and warning status. | Admin | | /resetrep | Reset the users platform reputation back to 0. Useful if you want to only target a single user without needing to edit their profile on the website | Admin | | /lastactive | See the last active date/time the user had been tracked by the platform. | All | | /report | If turned on in settings this allows the community users to help with moderation by reporting bad messages. | All | | /sreport | If turned on in settings this allows the community users to help with moderation by silently reporting bad messages. | All | ### **Chat Commands** The following commands can be used for real time chat management. | Command | Description | Access | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | | /fileid | Reply to a media message such as a video or document to get the file\_id value, this can be used in chat actions to send files of much larger file sizes than allowed via URL. | Admin | | /activate | Register the chat with the platform so that you can manage settings through the website. | Admin | | /silence | Only allow admins to chat. | Admin | | /unsilence | Allow all users to chat. | Admin | | /ua | Toggle under attack mode on/off. Kicks new joining users and silences chat. | Admin | | /underattack | Toggle under attack mode on/off. Kicks new joining users and silences chat. | Admin | | /pin | Pin a message via the bot to ensure it remains in place even if another user or telegram attempts to replace it. | Admin | | /unpin | Remove the enforced pinned message from the chat allowing all those with access to pin messages without being over-ridden. | Admin | | /debug | Display debug information for your chat which is useful for the support team to identify issues. | Admin | | /reload | To reduce API calls we cache the admin list of your chat for 12 hours. If you need to update your admin list you can refresh the cache using this command. | Admin | | /purge | Delete all messages between the message replied to with this command and the most recent message. State how many with /purge 5 to delete 5. | Admin | ### **Reputation Commands** The following commands are available if the reputation system is enabled for your chat. You are also able to reply to a user message to invoke the command without needing to use their username or ID. | Command | Description | Access | | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | | /rep | Increase the reputation of the target user by replying to their message with /rep or adding their username after /rep. | All | | /myrep | View your reputation statistics including how much reputation you can give out and the time until this regenerates. | All | | /toprep \[limit] \[d/w/m/y/ pd/pw/pm/py] | View a list of the current top reputation users for the chat. Optionally add a limit to specify how many ranks to show, as well as whether to show current or previous day, week, month or year stats. Example: /toprep 5 pd - Would show top 5 users from previous day | All | | /remrep | Decrease the reputation of the target user by replying to their message with /remrep or adding their username after /remrep. | All | ### **Referral Commands** The following commands are available if the referral system is enabled for your chat. | Command | Description | Access | | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | | /myrefs | View your referral statistics if used in a public chat. Show your unique referral link and stats if used in private message to a bot which has the referral system turned on. | All | | /toprefs \[limit] \[d/w/m/y/ pd/pw/pm/py] | View a list of the current top referring users for the chat. Optionally add a limit to specify how many ranks to show, as well as whether to show current or previous day, week, month or year stats. | All | # Creating & Managing Custom Commands As well as being able to use Modr8's built in commands there are tmes when you want to build your own. Whether its to display some web-links or further information for your community you can create commands to suit your needs following the instructions below. ### Creating A Custom Command 1. Login to the Modr8 Platform 2. Click `"Manage"` on your bot profile 3. Scroll to your Chat Profile and click `"Commands"` 4. Click `"Create"` on the `"Create A New Command"` card to open the command builder page 5. Select a trigger for your command using the drop-down in the `"Trigger"` row. This defines the start of the command and we support the following options: `/ # ! - . @` 6. Next you will provide a name for your command, this is the text used after the trigger for example: `"staff"` would work with the trigger `"/"` to be run as `/staff` in your chat 7. Enter a description for your command in the text area provided. The description shows up in the command list which Modr8 provides when users type `/commands` in the chat window 8. Define the `"Access"` level required to execute the command. You may want the command to only work for admins instead of all users. 9. The command output is defined in the `"Content"` text area. Here you can add all the command data you need using the rich text editor. 10. If you wish to display an image with your command add the web address to the `"Image"` text input. Make sure the file ends in `.png, .jpg, .gif or .mp4` to send correctly. 11. You can add buttons to the command output by clicking the button in the `"Message Buttons"` row. Often people add web links behind buttons. 12. Decide if you want the command output to be sent as a reply to the original command by enabling `"Reply To User"` 13. Decide if you want the output of the command to delete based on your bot response deletion setting or if you want the output to remain in the chat. If you enable `"Delete Response After Timeout"` the message is deleted. 14. Leave the `"Enabled"` toggle on unless you wish the command to be disabled by default and not run. 15. Click `"Submit"` to save your command

Command Builder using Modr8

{% hint style="info" %} You will notice your command is listed automatically when a user types /commands in your chat. This can be a good way to let users know the commands you have registered. We also list reputation, community reporting and referral commands here if you turn these modules on {% endhint %} ### Managing Commands Whenever you have created a command it is listed in a table on the command page.

Registered command list

With the registered command list you will see: * Command trigger and name, showing how users will execute the command in chat. * Command description explaining the command usage * Defined access level which could be everyone or admins only * Quick activation / de-activation toggel. Switching this will change whether a command will run or not * Pencil icon allows you to edit the command and make adjustments as needed * Red trash bin button will delete the command from your list * Copy button will provide a pop up with code to export and save as a back up or import into other chats

Exporting and importing commands in modr8 can all be done on the command page

### **Exporting Commands** To export commands from your chat level command list you have two options, which can be both found on the following page. 1. Login to the Modr8 Platform 2. Click `"Manage"` on your bot profile 3. Scroll to your Chat Profile and click `"Commands"` From here your two options for exporting commands can be found which are: 1. **Export One:** Clicking the copy icon beside your command in the registered command list, which opens a pop-up with text for you to copy. 2. **Export All:** Clicking "Export" button on the "Export Commands" card, which opens a pop-up with text for you to copy. The latter will export ALL commands from your chat, this can be useful when taking a full backup of your chat commands or wanting to export to import them into another chat. ### **Importing Commands** Whether you wish to import one command or a batch of commands you will do so in the same way. 1. Login to the Modr8 Platform 2. Click `"Manage"` on your bot profile 3. Scroll to your Chat Profile and click `"Commands"` 4. Paste your exported command into the `"Import Commands"` card 5. Click `"Import"` 6. You will then see your commands listed in the registered commands table. ### :question:FAQ & Troubleshooting
How do I personalise commands and show the users name and top rep ranks? * Create or edit a command * Scroll to the command content area * Click "Personalisation tag guide" green link at the bottom of the content area The personalisation guide will show you a series of tags between {{ }} symbols which can be added to your content. The bot will dynamically add this content when sending the message.
Can I create menu systems with my commands? Modr8 has the capability to link buttons to websites as well as other commands and actions.\ \ This means you could create a series of commands and then edit them to have buttons which link to each other.\ \ When a user clicks the button it will run the command you selected without having to type a command to run.
# Bot Command vs. Chat Command You may have seen when accessing the "Bot Menu" button that there is an option called "Bot Commands". These are commands which work in Private Message only with the bot and are not the same as chat commands which work within the public chat. We have found some users like to create advanced use-cases within private chats with their bots such as providing commands that can act as a menu. You can use the buttons of a command when creating it in the builder to link to other commands. {% hint style="warning" %} You are unable to export / import actions between "Bot Commands" and "Chat Commands" the two are incompatible due to fundamental differences in the functionality between a chat and a private chat. {% endhint %} To create a bot command: 1. Login to the Modr8 Platform 2. Click `"Manage"` on your bot profile 3. Click `"Bot menu"` below the profile image of your bot 4. Click `"Bot Commands"` 5. Click `"Create Command"` From here it is similar to creating chat level commands so [follow the instructions here.](/features/commands/creating-and-managing-custom-commands#creating-a-custom-command) ### :question:FAQ & Troubleshooting
I am trying to import a command but it is not showing Ensure you are not trying to import a command that was built for a chat. They are not compatible and will not work at the bot level. \ \ Bot level commands will only run in private message with your bot and do not offer the same options. Also check you have not altered the text you are importing, this can adjust formatting and sometimes break the parser.
# API Access & Zapier Integration ### Overview Modr8 offers bot owners the ability to access some of the data generated by the platform and your chat through its API. We have had cases where being able to access reputation data for users has allowed whole ecosystems to be built out including using reputation points to purchase swag and merchandise from stores.\ \ We also offer the ability for you to integrate your telegram mod bot with Zapier, a no/low code automation platform that will allow you to trigger messages with custom content into your chat. ### Gaining Access To Modr8 API Bot owners are able to access the Modr8 API credentials. These can then be passed on to a developer to authenticate with Modr8 API gateway and use the relevant methods for extracting data. 1. Login to the Modr8 platform 2. Select `"Manage"` on your bot profile 3. Select the `"Bot Menu"` below your bot profile image 4. Select `"API"` from the drop down menu 5. A token will be displayed in the grey input box, copy this to use for accessing the API. 6. Review instructions displayed on the API Information card to see the web address required to access the platform API. You are able to renew the token by clicking the red button labelled `"Renew Token"` ### API Methods & Usage The following table lists the existing API methods available and a description for their usage. We will be adding new methods as requested. | Topic | Method | End Point | Description | | ---------------------- | ------ | ------------------------------------------------------------ | -------------------------------------- | | Chat List | GET | chats/ | List of registered chats. | | Chat Users | GET | chats/{{chat\_id}}/users | List of tracked users in chat. | | Chat User | GET | chats/{{chat\_id}}/users/{{user\_id}} | Specific tracked user in a chat. | | All Reputation | GET | chats/{{chat\_id}}/reputation | Reputation points by user. | | Single User Reputation | GET | chats/{{chat\_id}}/reputation/{{user\_id}} | Retrieve reputation for a single user. | | Add User Reputation | PUT | chats/{{chat\_id}}/reputation/{{user\_id}}/add/{{amount}} | Add reputation points to a user. | | Remove User Reputation | PUT | chats/{{chat\_id}}/reputation/{{user\_id}}/remove/{{amount}} | Remove reputation points from a user. | ## Integrating Modr8 to Zapier Zapier is a web based tool that lets you connect web based apps and automate tasks between them. Modr8 has a custom Zapier connector which allows you to send messages from zapier flows through your Modr8 bot. Zapier offers 1000's of different apps that can trigger your Modr8 bot to issue a message. You might want to hook up a notification of e-mails hitting your inbox or tickets being created in your CRM system. It's all possible using Zapier and the Modr8 bot connector.

Use Modr8 Zapier Integration To Send Messages From 1000's Of Apps

### Getting Your Integration Setup The zapier connector is invite only and utilises the API key from Modr8 platform to authenticate your bot to the platform. To get connected complete the following steps. 1. Go to our Zapier connector invitation page 2. Accept the invite by clicking the `"Accept Invite & Build A Zap`" button. 3. Click `"+ Create"` at the top right of the screen and click `"Zaps"` to load the Zapier canvas 4. Select the `"+"` to load the Zap search and then type `"Modr8"` in the search bar 5. Select the Modr8 app listed, it will show an Invite Only flag 6. Select the `"Action event"` which is what action you wish the bot to take when it receives an input. For now select `"Send Message"` 7. Select `"Account"` and create a new connection, which will load a pop up screen. 8. Retrieve your API token for Modr8 using the instructions listed [here](#gaining-access-to-modr8-api) you will be looking for the API key. 9. Paste the API key into the pop-up input box and select `"Yes connect to Modr8"`, after a few seconds the connection will process and save. 10. Click `"Continue"` button at the bottom of the Send Message form. 11. Specify a chat identifier where you wish the message to be sent to. The ID for your chat can be found by typing **/debug** in your chat and seeing the ID field under `"Chat Details"` it usually starts with "-100"

The Chat Identifier Can Be Found By Typing /debug

12. Add the message text you wish to send, which could be injected from the node which triggers your zap to run. 13. Select `"Test Step"` and if everything goes well you can then continue building your zap! # Spam Prevention & Protection Whilst Telegram is a great platform for building private and public communities there is of course marketing, scam and phishing attempts from bad actors. The Modr8 engine is equipped with many features to combat these issues including a dedicated Spam Prevention Module. To access the module complete the following steps. Once on the page, the following sections will explain in detail what each of the settings are for and what changes to configuration you may want to make. 1. Select `"Manage"` on your bot profile from the homepage 2. Scroll to your chat profile 3. Select `"Settings"` on your chat profile 4. Select `"Edit"` on the `"Spam Prevention"` card You will then be presented with the following card sections and can set up your configuration. ### New User Spam Capture When a new user joins your chat, often their first message may contain a spam link. This is especially true for automated strategies where someone has programmed a bot user to spam marketing and spam messages.

Capturing user who spam as soon as they enter your chat is a great way to stop bad actors quickly

1. Scroll to the `"New User Spam Capture"` section 2. To block web links in first messages enable the `"Contains A Web Link"` switch. 3. To block a users first message being a forwarded message enable the `"Is A Forwarded Message"` switch 4. To block mentioning another channel / group or user in their first message enable `"Mentions Channel/User"` switch 5. To block a users first message from being some form of media such as polls, animations and videos you should enable `"Uses Media"` and then select items from the `"Remove Media List"` 6. The bot will delete the above messages, but also can execute further actions. Select what you would like to happen using the `"Execute Action"` drop down. This could be do nothing (just delete), mute the user, kicks the user or ban the user. If using mute, you can specify the duration. ### New User Restrictions When new users join your chat, you may wish to restrict the actions they can perform in your chat. Some communities do not want new users to be able to post photos / videos and voice messages for a defined period of time. This type of probationary period can be useful to stop spammers and scammer from sending media right away and they may move to other chats to find easier targets.

New user restrictions can act as a probationary period for new users joining your chat

1. Scroll to `"New User Restrictions"` section 2. Enable the module by turning on the `"Apply Restrictions"` switch 3. Select the type of messages you would like to be restricted by selecting fro the `"Message Types"` drop down list. 4. Toggle whether you wish to stop new users also being able to invite other users to the chat. with the `"User Invites"` option. This can stop raids and spam inviting bots. 5. Select how long to restrict users for using the `"Restricted For"` drop downs. Typically we recommend anywhere from 1 hour up to 24 hours works good. ### Federated Spam Protection We utilise a known bad actor/user list which is crowd sourced and maintained by SpamWatch. This list contains hundreds of thousands of peer reviewed spammers who have been issuing bad content to other communities. When this setting is turned on, users who match the list are automatically banned by Modr8.

SpamWatch list matching will auto-ban any users who have been identified as a spammer before.

1. Scroll to the `"Federated Spam Protection"` section. 2. Toggle the "Enable SpamWatch List" option to turn this setting on. ### Banning Button Links & Keyboards Sending keyboards with bots to the chat used to be a way spammers would provide links to websites and custom commands to collect user data. It's not really so popular anymore but we still keep the option here for good measure in case it becomes a method of attack again.

Some spammers use button links and bot keyboards in chats to create spam for users to click

1. Scroll down to the `"Button Links & Keyboards"` card section 2. Toggle the `"Remove Buttons/Keyboards"` toggle to enable the protection 3. Toggle whether you wish to issue a warning using the warning system when the bot identifies users who are spamming in this way. If your general settings have an outcome to exceeding the warning limit then that action will be executed once breached. ### Duplicate Message Checking You may want to stop users spamming the same message over and over. We have noticed that some marketing bots tend to do this over a few hours ot keep their message slowly feeding into your chat. We also see it as an attempt to flood the same message multiple times within seconds to gain attention. This setting will delete and warn users if detected.

Stopping duplicate messages is a great way to prevent slow spamming your chat over a period of time amongst other chatter

1. Scroll to the `"Duplicate Message Check"` card section 2. Toggle to enable the `"Remove Duplicates"` module 3. Select whether you wish to `"Issue Warning"` when a duplicate is detected. This will follow your warning system settings and may cause a kick, ban or mute if breaching your rules. 4. Specify `"Duplicate if sent within"` time period using the number input and drop-down. ### Message Flood Control The simplest of spam checks is stopping floods of messages being thrown into your chat. This could be the same message or a rotation of messages. This module records the last time a user sent a message against the time they sent their new message. If they breach your specified sensitivity then the message is deleted.

Simple flood message control helps to control the speed people chat at.

1. Scroll to the "Message Flood Control" card section 2. Toggle to enable the "Remove Flood Messages" module 3. Select whether you wish to `"Issue Warning"` when a flood is detected. This will follow your warning system settings and may cause a kick, ban or mute if breaching your rules. 4. Set a `"Flood Detection Sensitivity"` this is the time in seconds between previous and current messages. Typically 1 or 2 seconds is enough. If you have ideas for further spam detection modules please let us know! ### :question:FAQ & Troubleshooting # Media & Text Filters Modr8 has an array of built in options for you to filter media and text sent into your chat. Whether you wish to keep certain media out of your chat or you have identified some bad web-links being repeatedly used you can use our media & text filters module to take action. To gain access to the media & text filters module follow these steps: 1. Login to the Modr8 platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select `"Settings"` 4. Click `"Edit"` on the `"Media & Text Filters"` card The following sections are dedicated to explaining what each filter will do and how best to setup and amend its configuration options. ### Media Management The media management filter allows you to select which media the bot will delete as soon as it identifies a message of that type in the chat. It is a good way of keeping your chat clear of certain types of media that may need approval or you simply wish to keep clear of your group. Modr8 supports removing: Animations, Audio, Contacts, Documents, Games, Locations, Passports, Photos, Stickers, Venues, Videos, Voice Messages & Polls.

Media management module will delete media messages that meet your criteria from the chat

1. Login to the Modr8 platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select `"Settings"` 4. Click `"Edit"` on the `"Media & Text Filters"` card 5. Scroll to `"Media Management"` section 6. Enable the module by toggling the `"Remove Media"` switch 7. Click into the `"Remove Media List"` and select the media items you do not want in your chat from the drop-down list. 8. Elect to enable `"Issue Warning"` switch if you want the bot to delete & issue the user a warning. If they breach your warning limits set in your general settings then the warning breach action will run too. ### Forwarded Content Filter Often members will forward messages and content into your chat to share with the rest of the group. Sometimes this content may not be relevant, such as spam or promotions for other groups. The Modr8 engine supports removing these messages by you specifying either: * A list of users/channels/ID's you ONLY allow content to be forwarded from * A list of users/channels/ID's you DO NOT allow content to be forwarded from These two options make it easier for you to decide whether you work on a "deny by default" basis or an "allow with exceptions" basis. The choice is yours!

Forwarded content filters allow you to remove forwarded content that is sent to your chat by others

1. Login to the Modr8 platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select `"Settings"` 4. Click `"Edit"` on the `"Media & Text Filters"` card 5. Scroll down to the `"Forwarded Content"` section 6. Enable the `"Remove Forwarded Messages"` switch to enable the module 7. Elect to switch on the `"Issue Warning"` switch if you want the bot to delete & issue the user a warning. If they breach your warning limits set in your general settings then the warning breach action will run too. 8. Choose how you want your list to behave using the `"List Behaviour"` radio buttons. * **Whitelist** - You will provide a list of channels / usernames / ID's that you will ALLOW forwarded content from. * **Blacklist** - You will provide a list of channels / usernames / ID's that you DO NOT allow forwarded content from. 9. Add usernames or ID's to your "`Black/White List"` set with one item per row. 10. Add further rows by clicking the `"Add Row"` button ### Quoted / External Reply Content Filter Spammers will try and bypass message filters by replying to messages from other chats. Telegram allows this and it shows up as a quote in your chat, referencing the name of the external chat. It's a good way for spammers to promote other places and bad messages. The Modr8 engine supports removing these messages by you specifying either: * A list of users/channels/ID's you ONLY allow content to be replied from * A list of users/channels/ID's you DO NOT allow content to be replied from These two options make it easier for you to decide whether you work on a "deny by default" basis or an "allow with exceptions" basis. The choice is yours!
1. Login to the Modr8 platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select `"Settings"` 4. Click `"Edit"` on the `"Media & Text Filters"` card 5. Scroll down to the `"Quoted Content"` section 6. Enable the `"Remove Quoted Messages"` switch to enable the module 7. Elect to switch on the `"Issue Warning"` switch if you want the bot to delete & issue the user a warning. If they breach your warning limits set in your general settings then the warning breach action will run too. 8. Choose how you want your list to behave using the `"List Behaviour"` radio buttons. * **Whitelist** - You will provide a list of channels / usernames / ID's that you will ALLOW quoted content from. * **Blacklist** - You will provide a list of channels / usernames / ID's that you DO NOT allow quoted content from. 9. Add usernames or ID's to your "`Black/White List"` set with one item per row. 10. Add further rows by clicking the `"Add Row"` button ### Profanity Filtering Modr8 comes with a bult in list of profane words that can be used to filter against. This list includes various languages and also l33t sp34k versions for when users are attempting to hide the bad words they are using.

Modr8 Profanity Filter will delete any profanity in your chat.

1. Login to the Modr8 platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select `"Settings"` 4. Click `"Edit"` on the `"Media & Text Filters"` card 5. Scroll to the "Profanity Filter" section 6. Enable the module turning on the "Remove Profanity" switch 7. Elect to switch on the `"Issue Warning"` switch if you want the bot to delete & issue the user a warning. If they breach your warning limits set in your general settings then the warning breach action will run too. ### Link Filtering Being able to manage the web links shared by users in your chat is one of the most important filters you will use. Often users will use links for not just directing other users to web sites but also to other groups and invitations. You can use this module to delete links, even those which Telegram itself does not identify as a full web address will be identified by our algorithms. The Modr8 engine supports removing messages containing links by you specifying either: * A list of addresses, domains or sub domains you ONLY allow * A list of addresses, domains or sub domains you DO NOT allow These two options make it easier for you to decide whether you work on a "deny by default" basis or an "allow with exceptions" basis.

Modr8 link removal module will identify links in messages and allow you to set whether they should be deleted or not

1. Login to the Modr8 platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select `"Settings"` 4. Click `"Edit"` on the `"Media & Text Filters"` card 5. Scroll down to the `"Link Handling"` section 6. Enable the `"Block Web Links"` switch to enable the module 7. Elect to switch on the `"Issue Warning"` switch if you want the bot to delete & issue the user a warning. If they breach your warning limits set in your general settings then the warning breach action will run too. 8. Choose how you want your list to behave using the `"List Behaviour"` radio buttons. * Whitelist - A list of addresses, domains or sub domains you ONLY allow * Blacklist - A list of addresses, domains or sub domains you DO NOT allow 9. Add domains, full addresses or partial addresses into the "`Link List"` set with one item per row. 10. Add further rows by clicking the `"New Row"` button ### Excessive Emojis Filter There can be times where you have people using excessive amounts of emojis in chats. This can happen in single messages where someone is promoting or issuing an advert type of message. Modr8 can filter messages which breach a limit you set for the number of emojis that can be used in a single message.

Modr8 can filter messages that breach you limit of allowable emojis per message

1. Login to the Modr8 platform 2. Select `"Manage"` on your bot profile 3. Scroll to your chat profile and select `"Settings"` 4. Click `"Edit"` on the `"Media & Text Filters"` card 5. Scroll down to the `"Excessive Emojis Filter"` 6. Enable the `"Remove Emojis"` toggle switch to activate the module 7. Enter the number of emojis you will allow per message in the `"Maximum Allowed Emojis"` input box 8. Elect to switch on the `"Issue Warning"` switch if you want the bot to delete & issue the user a warning. If they breach your warning limits set in your general settings then the warning breach action will run too. ### Regular Expression Filtering If you have specific text patterns you wish to delete within your chat you can use Regular Expression filters to do so. This area is often used when there are simple patterns you wish to match, but if you need something more advanced or more customisations you can use our Actions engine. \ \ When a keyword is matched against the message then it is removed from your chat.

Regular Expression Filtering

1. Select `"Settings"` on your chat profile 2. Select `"Edit"` on the `"Advanced Settings"` card 3. Scroll down & turn on`"Enable RegEx Filtering"` toggle 4. Elect to issue a `"Warn on Regex Match"` to use the warning system 5. Elect to display a message saying a message was deleted due to meeting a rule by enabling `"Display Deletion Notification"` 6. Add in your regular expression rules, one per row in the `"RegEx Rules"` section. We recommend testing out your rules at RegExr.com and for anything more advanced you'll want to use our [Actions module.](/features/actions) ### :question:FAQ & Troubleshooting
I want to block people sending invitations to WhatsApp or Telegram groups You'll want to use the Link Filtering module for this. In this module make sure you have configured it to work as a blacklist and provide the following links to the link list, one per row:
# Affiliates & Partnerships ### Become An Affiliate & Earn With Modr8 Referrals Do you love Modr8 and find you are often recommending it to other communities and clients? Well you can now get paid for referring these customers to Modr8! We partnered with LemonSqueezy for our payments and affiliate campaigns. For every customer you refer that takes out one of our plans you will receive 20% of the margin! We've also enabled this to be an ongoing 20% for every subscription payment if they subscribe.\ \ Unlike many referral / affiliate systems we will pay you in cash direct to your bank or PayPal. #### Get Started As An Affiliate To become an affiliate and start earning follow these steps. 1. Go to 2. Select "Become an affiliate" 3. Complete the short sign-up form and submit your details 4. LemonSqueezy will review your details to ensure you are not spamming us with AI or Bot traffic 5. Within 48 hours your application will be reviewed and if accepted you will receive an e-mail with your unique referral link/code. 6. Re-visit LemonSqueezy to add your preferred pay-out channel such as Bank or PayPal. 7. Provide this link to any clients/customers and our website will track they have visited using your referral 8. Upon completing checkout and making a payment your dashboard will update on the LemonSqueezy website 9. Receive your payout once reaching the $10 limit and 30 days have passed. #### Affiliate Program Setup Below we've listed out the current settings being used for our affiliate campaign so you can be sure you have a full view of how it is set up. * Minimum payout amount: $10 * Credit the last referrer if multiple links are clicked * Track referrals for 14 days after link clicked * Commission type 20% * Recurring commissions for subscriptions on each successful payment * All Modr8 products can earn commission * Payouts can be made to PayPal or Bank * Auto approval of affiliates that pass LemonSqueezy due-diligence checks * Sign up / Login address