Skip to main content

​
Root Command

There are three system message commands, each with the same subcommands.
  • welcome - Dispatched whenever a user joins the server.
  • goodbye - Dispatched whenever a user leaves the server.
  • rejoin - Dispatched whenver a user rejoins the server.
  • boost - Dispatched whenever a user boosts the server.
The following examples use the welcome command, but the same syntax applies to the other system message commands as well.
The rejoin event is dispatched whenever a user leaves and rejoins the server. If this event exists, and is dispatched, it will prevent any welcome messages from being sent.

​
Creating a System Message

Use the welcome add subcommand to create a welcome message.
The --delete_after flag in system messages schedules the message for deletion after a specified time, which must be between 3 and 120 seconds.
;welcome add <channel> <script> [--delete_after [3-120]]

​
Removing a System Message

Use the welcome remove subcommand to remove a welcome message. 
;welcome remove <channel>

​
Additional Commands

Use the welcome view subcommand to view the script of a welcome message.
;welcome view <channel>
Use the welcome clear subcommand to remove all welcome messages.
Use the welcome list subcommand to view all welcome messages.
The boost event is only dispatched if the server has the Discord System Message enabled or whenever the user receives the Server Booster role which only occurs once.