Forms
Features
- Set up forms to collect information from users.
- Customize the questions and the dialog appearance.
- Send a form into a ticket via a command with minimal effort.
- Optionally require form submission before users can continue in Modmail or the Ticket System.
- Lock ticket channels until the form has been submitted (Ticket System only).
Setup
- Visit the Forms page in your dashboard.
- Configure the available options.
- Create a new form by clicking the "Create new form" button.
- Configure the available options for the respective form.
- Create a new form question by clicking "Edit form" in the configuration and then clicking "Add field".
- Configure the available options for the respective form question.
Commands
Understand the documentation
In these docs,
name:<Type> is an option of a slash-command with name name and the type Type. Options that not required, are described as [name:<Type>]. If the action of a command is vastly different between required and not-required options, we might list them separately.Examples
/moderate ban user:<Member>: This command (/moderate ban) has an required option with the name "user" that only accepts one member as a value./moderate ban victim:<Member> reason:<Text>: This command (/moderate ban) has an required option with the name "victim" that only accepts one member as a value and another required option with the name "reason" that accepts any text as an value./moderate ban victim:<Member> reason:<Text> [proof:<Attachment>]: This command (/moderate ban) has an required option with the name "victim" that only accepts one member as a value, another required option with the name "reason" that accepts any text as an value and a not-required option with the name "proof" which allows one attachment as its value.
| Command | Description |
|---|---|
/ticket form form:<FormName> | Sends a form into the corresponding ticket. |
Configuration
Main configuration
| Field | Description |
|---|---|
| Dialog open button | This text is shown on the button that opens the form dialog, which is attached to the message sent by the /ticket form command. |
| Open dialog message (Modmail) | This message is sent when a user is asked to fill out a form in a Modmail ticket.RequirementOnly available if Modmail is enabled. |
| Require form submission (Modmail) | If enabled, users cannot continue in Modmail until the form has been submitted.RequirementOnly available if Modmail is enabled. |
| Ticket form message (Ticket System) | This message is sent in the ticket channel when a form is requested.RequirementOnly available if the Ticket System is enabled. |
| Lock channel until form is submitted (Ticket System) | If enabled, the user cannot send messages in the ticket channel until the form has been submitted.RequirementOnly available if the Ticket System is enabled. |
| Allow additional ticket members to submit forms | If enabled, additional ticket members (not just the ticket owner) can submit forms in the ticket.RequirementOnly available if the Ticket System is enabled and "Allow additional ticket members" is enabled in the Ticket System configuration. |
Manage forms
| Field | Description |
|---|---|
| Form name | This text is shown as the title of your form and in the form selection menu. |
| Dialog | These questions are shown in the form. More information on configuring form questions can be found here. |
Manage form questions
| Field | Description |
|---|---|
| Label | This text is shown as the title of your question. |
| Field type | Depending on the selection, the user gets a small or large field (allows line breaks) to enter text. |
| Placeholder | This text is used as the placeholder in the input field. |
| Is this field required? | If enabled, the user must fill out this field. |
| Minimum input length | The minimum number of characters the user must enter to submit the dialog. |
| Maximum input length | The maximum number of characters the user is allowed to enter to submit the dialog. |