Triggers and responses

This page lists what an AutoMod rule can look for and what it can do about it. Both are plain values: build them, tune them, then give them to a rule builder or to an existing rule. You're assumed to have a bot named "my-bot" logged in.

How triggers work

A trigger is created by one of five expressions, one per kind. Its options are write-only properties, and each one only applies to the kinds listed next to it: setting filtered keywords on a mention spam trigger is a readable error, not a silent no-op.

on message received seen by "my-bot":
    if discord content of event-message is "!words":
        set {_t} to a new automod keyword trigger with the keywords "badword"
        add "*worse*" to filtered keywords of {_t}
        set allow list of {_t} to "badwordle"
        set {_b} to a new automod rule builder named "Words" in event-guild for messages using {_t}
        add a new automod response blocking the message to automod responses of {_b}
        await set {_rule} to the build result of {_b}

Trigger kinds

Keywords accept a * wildcard at the start, the end or both ("*bad*" matches inside a word). Patterns are regular expressions in Rust syntax, 10 patterns of 260 characters at most. A keyword and a pattern trigger are the same Discord kind: a keyword trigger can also hold patterns, and the reverse; it needs at least one of either when the rule is built.

The presets are Discord's maintained word lists: profanity, sexual content and slurs.

Trigger options

set {_presets} to a new automod preset trigger with the presets profanity and slurs
add sexual content to presets of {_presets}
set allow list of {_presets} to "scunthorpe"

set {_mentions} to a new automod mention spam trigger with a limit of 5
set mention raid protection of {_mentions} to true

Responses

A response is created by one of four expressions and never changes afterwards. A rule holds at most one response of each type: adding a second one of the same type replaces the first.

The custom message of a blocked message is shown to its author, 150 characters at most. A timeout lasts up to 28 days.

set {_block} to a new automod response blocking the message with the custom message "Keep it clean"
set {_alert} to a new automod response sending an alert to the channel event-channel
set {_mute} to a new automod response timing the member out for 5 minutes
set automod responses of {_b} to {_block}, {_alert} and {_mute}

A response reads back through response type, response message, response channel and response timeout; each is none when it does not apply to the response's type. response type compares against block message, send alert message, timeout and block member interaction.

Errors you may see