Create a Thread
Last updated
Last updated
This action cannot be used for forum channels! For forum thread creation, use discord API here.
The Create a Thread block enables you to create threads within your server through commands or events.
Each created thread has a unique variable that you can use to reference the thread in your command and can be identified by just looking for {created_thread_xyz}
.
To create the thread, you need to specify what channel you are going to create the thread in. There is three provided options to achieve this.
This selection will create the thread in the channel that the command / event was executed in or where a button / menu option was clicked.
This an optional field allows you to create the thread from a specific message. The only input for this field is a plain message ID with no extra symbols or spaces. A variable can be used as well.
This is a required option, and it is the name of the thread that you want to create. You can use variables or options as well.
This is an optional option (public is default), and it is the type of thread that you want to create. You can choose from 3 types of thread types.
Public Thread
This type of thread is public which means it can be viewed by everyone in the server or everyone who has access to the channel it is in.
Private Thread
This is the opposite of the Public Thread type which means it can't be viewed by everyone.
Announcement Thread
This thread works similar to an announcement channel, any message in this thread can be published.
This is an optional field, and it is the time in which the thread will auto-archive itself. You can choose from 4 options:
One Hour
One Day
Three Days
One Week
This is an optional field. In this field you can input a reason why you are creating a thread. This reason will be shown in your server's audit log. Variables can also be used in this field.
This is an optional field, also known as rate limit per user, it allows you to set a slowmode in the thread for each user unless the user has been bypassed. This field only accepts integers, and variables can be used.
This option is only valid if the thread type is a Private Thread. This field is optional and it allows you to toggle whether a non-moderator can invite other users to the thread.
You can now access various variables from the created thread and use them throughout your custom command (as long as it is in the same interaction).
You can use these variables by just adding them to the end of the {created_thread_abcd}
variable, but before the }
. The 4 characters "abcd" are shown in your create thread block at the top.
An example to get the name would be like this: {created_thread_48f3.name}
.
.name
Returns the name of the thread
.id
Returns the ID of the thread
.parent
Returns the parent channel of the thread
.parent_id
Returns the parent's ID of the thread
.archived
Returns whether the thread is archived or not (as true
or false
)
.locked
Returns whether the thread is locked or not (as true
or false
)
.invitable
Returns whether a non-moderator can invite users to the thread or not (as true
or false
)
.owner_id
Returns the thread owner's ID
.url
Returns the url of the thread
Enable Success / Error Handles to detect success and errors inside of the action block. This allows you to run different actions if something goes wrong with your action. Inside of the handle, there are 2 different paths which are used to detect the outcome of the action. The green path on the bottom left side of the block indicates success, while the red path on the bottom right side of the block indicates error. You may attach action blocks to each side of the handle to get the outcome of your action block.
The Success/Error Handles feature includes 3 different error variables you can use to get information on why the action block encountered an error. Check them out here.