Moderation Tools

Any user is allowed to flag a message. This triggers the message.flagged webhook event and adds the message to the inbox of your Stream Dashboard Chat Moderation view.

You can enhance flags by associating them with a specific reason and custom data. It is advisable to utilise a slug or keyword as a designated reason for easy translation or other forms of display customisation.

The custom data can encompass any object, offering supplementary metadata to the flag.

The Query Message Flags endpoint retrieves both reasons and custom data, and the reason can also be utilised for filtering these flags.

If you prefer to build your own in-app moderation dashboard, rather than use the Stream dashboard, then the query message flags endpoint lets you get flagged messages. Similar to other queries in Stream Chat, you can filter the flags using query operators.

Both server-authenticated and user-authenticated clients can use this method. For client-side requests, the user needs moderator or admin permissions. This default behavior is controlled by the ReadMessageFlags permission and can be customized if needed. Read our permissions documentation to learn more.

Pagination for message flags can be done using the offset/limit options. Flags are returned in ascending order of creation, starting from the most recent flag.

Any user is allowed to mute another user. Mutes are stored at the user level and returned with the rest of the user information when connectUser is called. A user will be muted until the user is unmuted or the mute is expired.

After muting a user messages will still be delivered via web-socket. Implementing business logic such as hiding messages from muted users or displaying them differently is left to the developer to implement.

Users can be banned from an app entirely or from a channel. When a user is banned, they will not be allowed to post messages until the ban is removed or expired but will be able to connect to Chat and to channels as before.

Channel watchers cannot be banned.

It is also possible to ban the user's last known IP address to prevent the creation of new "throw-away" accounts. This type of ban is only applicable on the app level. We do not recommend applying an IP ban without a reasonable timeout, however, this is not restricted. The IP address will be unbanned either after reaching a timeout or with explicit user unban.

In most cases, only admins or moderators are allowed to ban other users from a channel.

Banned users can be retrieved in different ways:

1. Using the dedicated query bans endpoint

2. User Search: you can add the banned: true condition to your search. Please note that this will only return users that were banned at the app level and not the ones that were banned only on channels.

The query bans endpoint allows you to list bans for your application. Similar to other query endpoints, you can filter bans by different fields and control the ordering of results.

Pagination for bans can be done in two ways: using offset/limit or using the created_at field. Bans are returned in ascending order by default so to get the second page you need to request bans with created_at less than the created_at of the last ban on the first page. Ordering can be reversed using the sort option.

Instead of a default ban, you can shadow ban users from a channel, set of channels, or an entire App. When a user is shadow banned, they will still be allowed to post messages, but any message sent during the ban will only be visible to the author of the message and invisible to other users of the App.

Shadow banning can delay a persistent bad actor from attempting ban evasion techniques by obfuscating the fact that a ban has occurred for them. Since a shadow ban's effectiveness relies on it not being discovered, shadow bans work best in chats with a high volume of messages and fast velocity where the offending user's messages not receiving engagement appears plausible; think livestreams.

Messages from a shadow banned user will include the shadowed: true flag on the message object. This flag is only visible to users other than the shadow banned user, so the offender will not be able to recognize that they are shadow banned even if they use developer tools to inspect responses from the API. You will need to implement UI logic for how your application will handle shadowed messages. Having the client hide these messages for everybody other than the user sending them is a common approach.

Administrators can view shadow banned user status in queryChannels(), queryMembers() and queryUsers().

A list of words you can define to moderate chat messages. A blocklist can be assigned to each channel type to either block or flag messages that contain these words. More information can be found here.

Stream AutoMod uses an AI-based classification system to detect various types of bad content. The tool is powered by AI, an is highly configurable for each channel type to assist the manual work of human moderators. You can learn more here.