Advanced Moderation Guide v1
Advanced Moderation Guide
Advanced Moderation Guide
Version 1

Rules is a moderating system that works based on a set of conditions and actions. It functions as the key decision engine of Sendbird's Advanced Moderation where it listens to events that are detected, checks if it falls under the conditions set, and then takes the appropriate action. The general idea of how rule engine works is shown in the diagram below.


How it works

Copy link

Step 1. Detection: In the first step, events are automatically detected using Profanity filter or Hive AI. When detected, it alerts the engine to check if the event falls under the conditions set in the rule engine.

Step 2. Condition check: The engine checks if the detected event meets the conditions set in the rule engine.

Step 3. Action: The engine then takes the appropriate action based on the conditions met. There are different types of actions available in the rule engine, such as muting or banning a user, deleting a message, or sending the message to review queue.


How to create a rule

Copy link

To create a rule, follow the steps below:

  1. Sign in to your Sendbird Dashboard and go to your Application > Moderation > Advanced moderation > Rules, then click Create +.

  1. Provide a title and a description for the rule.

  2. Select a Rule type.

The following table shows the available rule types:

TypeDescriptionExample

Event-driven

Immediately triggers an action when the specified event takes place.

Mute a user when they send a message containing profanity.

Count-based

Only triggers an action when the count conditions are met.

Mute a user when they send a message containing profanity 3 times within a specified time frame.


  1. Set up Event. This is where you set which event triggers the rule engine.

The following table shows the available event triggers:

WhenDescription

a Message

- is deleted
- is reported
- is detected by profanity filter
- is blocked by profanity filter
- is replaced by profanity filter
- is detected by Hive AI

a User

- is reported
- is muted

You can also configure additional conditions for event triggers. For instance, you can monitor by specific channel custom types, channel types, channel URLs, report categories, reported message types, user types, and more.

  1. Set up Counting method (For count-based rule only).

FieldDescriptionExample

Count events by

Specify the criteria you wish to categorize and count events.

For example, if you set message sender as a criterion, events from sender A and sender B will be tallied independently.

Counting period

When the rule engine is triggered, it looks back over the specified period of time, counting how many times the particular event occurred.

For example, if you set 1 hour as the counting period, and the rule is triggered at 3 PM on a Tuesday, the engine will look back from that time to 2 PM of the same day, counting how many times the specified event occurred within that 1-hour window.


  1. Set up Action. This is where you define what action the rule engine should take when the conditions are met.

FieldDescription

Count condition (only for count-based rule type)

Based on the counting method configured, you can specify the required number of occurrences for the action to be triggered.

Action

Set up the action to be taken when all the conditions set above meet the criteria. The following are the available actions:

1. Ban or mute users:
- from a single channel
- from all channels of the same custom type
- from all channels within the application

2. Create a ticket:
- For more information, view this page.

3. Send moderator message:
- You can enter a moderator message to send.

Explore more on our Advanced moderation product page.