Skip to content

Commit 370bfe9

Browse files
authored
Update automod trigger types section (#5063)
- Add note about unreleased types - Merge limits table into main trigger types table - Fix links to trigger metadata section
1 parent d3d478c commit 370bfe9

File tree

1 file changed

+12
-23
lines changed

1 file changed

+12
-23
lines changed

docs/resources/Auto_Moderation.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,17 @@ Rules can be configured to automatically execute actions whenever they trigger.
5353

5454
###### Trigger Types
5555

56+
> info
57+
> The `HARMFUL_LINK` and `SPAM` trigger types are not yet released, so they cannot be used in most servers.
58+
5659
Characterizes the type of content which can trigger the rule.
5760

58-
| Type | Value | Description |
59-
| -------------------- | ------- | -------------------------------------------------------------------- |
60-
| KEYWORD | 1 | check if content contains words from a user defined list of keywords |
61-
| HARMFUL_LINK | 2 | check if content contains any harmful links |
62-
| SPAM | 3 | check if content represents generic spam |
63-
| KEYWORD_PRESET | 4 | check if content contains words from internal pre-defined wordsets |
61+
| Type | Value | Description | Max per Guild |
62+
| -------------------- | ------- | -------------------------------------------------------------------- | ------------- |
63+
| KEYWORD | 1 | check if content contains words from a user defined list of keywords | 3 |
64+
| HARMFUL_LINK | 2 | check if content contains any harmful links | 1 |
65+
| SPAM | 3 | check if content represents generic spam | 1 |
66+
| KEYWORD_PRESET | 4 | check if content contains words from internal pre-defined wordsets | 1 |
6467

6568
###### Trigger Metadata
6669

@@ -135,7 +138,6 @@ Use the `*` wildcard symbol at the beginning and end of a keyword to define how
135138
| the mat | **the mat** |
136139

137140

138-
139141
### Auto Moderation Action Object
140142

141143
An action which will execute whenever a rule is triggered.
@@ -178,17 +180,6 @@ value of [action type](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-action-ob
178180
Users are required to have the `MANAGE_GUILD` permission to access all Auto Moderation resources.
179181
Some [action types](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-action-object-action-types) require additional permissions, e.g. the `TIMEOUT` action type requires an additional `MODERATE_MEMBERS` permission.
180182

181-
### Auto Moderation Limits Per Trigger Type
182-
183-
Number of rules allowed per trigger type in each guild.
184-
185-
| Type | Max Per Guild |
186-
| -------------- | ------------- |
187-
| KEYWORD | 3 |
188-
| HARMFUL_LINK | 1 |
189-
| SPAM | 1 |
190-
| KEYWORD_PRESET | 1 |
191-
192183
## List Auto Moderation Rules for Guild % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/auto-moderation/rules
193184

194185
Get a list of all rules currently configured for guild. Returns a list of [auto moderation rule](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object) objects for the given guild.
@@ -223,10 +214,10 @@ Create a new rule. Returns an [auto moderation rule](#DOCS_RESOURCES_AUTO_MODERA
223214
| exempt_roles? | array of snowflakes | the role ids that should not be affected by the rule (Maximum of 20) |
224215
| exempt_channels? | array of snowflakes | the channel ids that should not be affected by the rule (Maximum of 50) |
225216

226-
\* Can be omitted based on `trigger_type`. See the `Associated Trigger Types` column in [trigger metadata](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-trigger-types) to understand which `trigger_type` values require `trigger_metadata` to be set.
217+
\* Can be omitted based on `trigger_type`. See the `Associated Trigger Types` column in [trigger metadata](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-trigger-metadata) to understand which `trigger_type` values require `trigger_metadata` to be set.
227218

228219
> info
229-
> See [Auto Moderation Limits Per Trigger Type](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-limits-per-trigger-type) for limits on how many rules of each trigger type can be created per guild.
220+
> See [Trigger Types](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-trigger-types) for limits on how many rules of each trigger type can be created per guild.
230221
231222

232223
## Modify Auto Moderation Rule % PATCH /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/auto-moderation/rules/{auto_moderation_rule.id#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object}
@@ -251,13 +242,11 @@ Modify an existing rule. Returns an [auto moderation rule](#DOCS_RESOURCES_AUTO_
251242
| exempt_roles | array of snowflakes | the role ids that should not be affected by the rule (Maximum of 20) |
252243
| exempt_channels | array of snowflakes | the channel ids that should not be affected by the rule (Maximum of 50) |
253244

254-
\* Can be omitted based on `trigger_type`. See the `Associated Trigger Types` column in [trigger metadata](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-trigger-types) to understand which `trigger_type` values require `trigger_metadata` to be set.
245+
\* Can be omitted based on `trigger_type`. See the `Associated Trigger Types` column in [trigger metadata](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object-trigger-metadata) to understand which `trigger_type` values require `trigger_metadata` to be set.
255246

256247
## Delete Auto Moderation Rule % DELETE /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/auto-moderation/rules/{auto_moderation_rule.id#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object}
257248

258249
Delete a rule. Returns a `204` on success.
259250

260251
> info
261252
> Requires `MANAGE_GUILD` [permissions](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-permission-requirements)
262-
263-

0 commit comments

Comments
 (0)