Add Automod documentation (#4860)

Co-authored-by: advaith <[email protected]> Co-authored-by: Jupith <[email protected]> Co-authored-by: Bryan Fernandes <[email protected]> Co-authored-by: Vitor <[email protected]> Co-authored-by: Zane Pereira <[email protected]> Co-authored-by: Shay DeWael <[email protected]> Co-authored-by: Splatterxl <[email protected]> Co-authored-by: Hemu <[email protected]>
discord · Jun 16, 2022 · d3d478c · d3d478c
1 parent 4fa7db8
commit d3d478c
Show file tree

Hide file tree

Showing 6 changed files with 337 additions and 4 deletions.
diff --git a/docs/Change_Log.md b/docs/Change_Log.md
@@ -1,5 +1,15 @@
 # Change Log
 
+## Auto Moderation
+
+#### Jun 16, 2022
+
+Add new [Auto Moderation feature](#DOCS_RESOURCES_AUTO_MODERATION) which enables guilds to moderate message content based on keywords, harmful links, and unwanted spam. This change includes:
+- New endpoints for [creating](#DOCS_RESOURCES_AUTO_MODERATION/create-auto-moderation-rule), [updating](#DOCS_RESOURCES_AUTO_MODERATION/modify-auto-moderation-rule), and [deleting](#DOCS_RESOURCES_AUTO_MODERATION/delete-auto-moderation-rule) Auto Moderation rules
+- New gateway events emitted when Auto Moderation rules are [created](#DOCS_TOPICS_GATEWAY/auto-moderation-rule-create) (`AUTO_MODERATION_RULE_CREATE`), [updated](#DOCS_TOPICS_GATEWAY/auto-moderation-rule-update) (`AUTO_MODERATION_RULE_UPDATE `), and [deleted](#DOCS_TOPICS_GATEWAY/auto-moderation-rule-delete) (`AUTO_MODERATION_RULE_DELETE `). Requires the `AUTO_MODERATION_CONFIGURATION` (`1 << 20`) intent
+- New gateway event emitted when an [action is executed](#DOCS_TOPICS_GATEWAY/auto-moderation-action-execution) (`AUTO_MODERATION_ACTION_EXECUTION`). Requires the `AUTO_MODERATION_EXECUTION` (`1 << 21`) intent
+- New [audit log entries](#DOCS_RESOURCES_AUDIT_LOG/audit-log-entry-object-audit-log-events) when rules are created (`AUTO_MODERATION_RULE_CREATE`), updated (`AUTO_MODERATION_RULE_UPDATE`), or deleted (`AUTO_MODERATION_RULE_DELETE`), or when AutoMod performs an action (`AUTO_MODERATION_BLOCK_MESSAGE`)
+
 ## Updated Command Permissions
 
 #### Apr 27, 2022

diff --git a/docs/resources/Audit_Log.md b/docs/resources/Audit_Log.md
@@ -13,11 +13,12 @@ When an app is performing an eligible action using the APIs, it can pass an `X-A
 | Field                  | Type                                                                                                         | Description                                                 |
 | ---------------------- | ------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |
 | audit_log_entries      | array of [audit log entry](#DOCS_RESOURCES_AUDIT_LOG/audit-log-entry-object) objects                         | List of audit log entries, sorted from most to least recent |
-| guild_scheduled_events | array of [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) objects | List of guild scheduled events found in the audit log       |
+| auto_moderation_rules  | array of [auto moderation rule](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object) objects         | List of auto moderation rules referenced in the audit log   |
+| guild_scheduled_events | array of [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) objects | List of guild scheduled events referenced in the audit log  |
 | integrations           | array of partial [integration](#DOCS_RESOURCES_GUILD/integration-object) objects                             | List of partial integration objects                         |
-| threads                | array of thread-specific [channel](#DOCS_RESOURCES_CHANNEL/channel-object) objects                           | List of threads found in the audit log\*                    |
-| users                  | array of [user](#DOCS_RESOURCES_USER/user-object) objects                                                    | List of users found in the audit log                        |
-| webhooks               | array of [webhook](#DOCS_RESOURCES_WEBHOOK/webhook-object) objects                                           | List of webhooks found in the audit log                     |
+| threads                | array of thread-specific [channel](#DOCS_RESOURCES_CHANNEL/channel-object) objects                           | List of threads referenced in the audit log\*               |
+| users                  | array of [user](#DOCS_RESOURCES_USER/user-object) objects                                                    | List of users referenced in the audit log                   |
+| webhooks               | array of [webhook](#DOCS_RESOURCES_WEBHOOK/webhook-object) objects                                           | List of webhooks referenced in the audit log                |
 
 \* Threads referenced in `THREAD_CREATE` and `THREAD_UPDATE` events are included in the threads map since archived threads might not be kept in memory by clients.
 
@@ -120,6 +121,10 @@ If no object is noted, there won't be a `changes` array in the entry, though oth
 | THREAD_UPDATE                         | 111   | Thread was updated                                        | [Thread](#DOCS_RESOURCES_CHANNEL/thread-metadata-object)                                                                                         |
 | THREAD_DELETE                         | 112   | Thread was deleted                                        | [Thread](#DOCS_RESOURCES_CHANNEL/thread-metadata-object)                                                                                         |
 | APPLICATION_COMMAND_PERMISSION_UPDATE | 121   | Permissions were updated for a command                    | [Command Permission](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/application-command-permissions-object-application-command-permissions-structure)\* |
+| AUTO_MODERATION_RULE_CREATE           | 140   | Auto Moderation rule was created                          | [Auto Moderation Rule](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object)                                                              |
+| AUTO_MODERATION_RULE_UPDATE           | 141   | Auto Moderation rule was updated                          | [Auto Moderation Rule](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object)                                                              |
+| AUTO_MODERATION_RULE_DELETE           | 142   | Auto Moderation rule was deleted                          | [Auto Moderation Rule](#DOCS_RESOURCES_AUTO_MODERATION/auto-moderation-rule-object)                                                              |
+| AUTO_MODERATION_BLOCK_MESSAGE         | 143   | Message was blocked by AutoMod (according to a rule)      |                                                                                                                                                  |
 
 \* Object has exception(s) to available keys. See the [exceptions](#DOCS_RESOURCES_AUDIT_LOG/audit-log-change-object-audit-log-change-exceptions) section below for details.