3.4. Modals
Modals (also called Forms) are interactive pop-up windows that appear when users click on a ticket panel button. They allow you to collect structured information from users before creating a ticket, such as their issue description, contact information, or any other relevant details. The responses are then displayed in the ticket channel when it's created.
Creating a Modal
To create a new modal, navigate to the Modals page in your dashboard and enter a form title in the "Create New Form" section. Click "Create" to create an empty modal that you can then configure with fields.
Note: Modal titles have a maximum length of 45 characters (Discord's limit). Modal names (used for identification) can be up to 100 characters.
Field Types
Modals support up to 5 fields, and each field can be one of the following types:
Text Input
A text field where users can type their response. Perfect for collecting free-form text like descriptions, questions, or contact information.
Configuration Options:
- Label: The field name displayed to users (required)
- Description: Optional help text shown below the label
- Placeholder: Example text shown in the input field when empty
- Style: Choose between "Short" (single line) or "Paragraph" (multi-line)
- Required: Whether users must fill this field before submitting
String Select
A dropdown menu with predefined options. Users select one or more options from a list you create. Ideal for categories, priorities, or any situation where you want standardized responses.
Configuration Options:
- Label: The field name displayed to users (required)
- Description: Optional help text shown below the label
- Options: Add multiple options, each with a label, value, and optional description
- Minimum Selections: How many options users must select (0 to number of options)
- Maximum Selections: How many options users can select (1 to number of options)
- Required: Whether users must make at least one selection
Tip: You must add at least one option before you can configure minimum/maximum selections. The maximum selections cannot exceed the number of options you've created.
User Select
Allows users to select one or more Discord users from the server. Useful for reporting issues with specific users or requesting help from particular team members.
Configuration Options:
- Label: The field name displayed to users (required)
- Minimum Selections: How many users must be selected (0-1024)
- Maximum Selections: How many users can be selected (1-1024)
- Required: Whether users must make at least one selection
Role Select
Allows users to select one or more Discord roles from the server. Useful for categorizing tickets by role or identifying which team should handle the request.
Configuration Options:
- Label: The field name displayed to users (required)
- Minimum Selections: How many roles must be selected (0-1024)
- Maximum Selections: How many roles can be selected (1-1024)
- Required: Whether users must make at least one selection
Mentionable Select
Allows users to select either users or roles (mentionable entities). Provides flexibility when you want to allow selection of either type.
Configuration Options:
- Label: The field name displayed to users (required)
- Minimum Selections: How many mentionables must be selected (0-1024)
- Maximum Selections: How many mentionables can be selected (1-1024)
- Required: Whether users must make at least one selection
Channel Select
Allows users to select one or more Discord channels from the server. Useful for reporting issues with specific channels or referencing related channels.
Configuration Options:
- Label: The field name displayed to users (required)
- Minimum Selections: How many channels must be selected (0-1024)
- Maximum Selections: How many channels can be selected (1-1024)
- Required: Whether users must make at least one selection
File Upload
Allows users to upload one or more files. Perfect for collecting screenshots, logs, or other attachments that help explain the issue.
Configuration Options:
- Label: The field name displayed to users (required)
- Description: Optional help text shown below the label
- Minimum Selections: How many files must be uploaded (0-10)
- Maximum Selections: How many files can be uploaded (1-10)
- Required: Whether users must upload at least one file
Note: File uploads are limited to 10 files per field. Each file must comply with Discord's file size limits.
Configuring Fields
For each field in your modal, you can configure the following:
| Setting | Description |
|---|---|
| Label | The name of the field that users will see. This is required for all field types. |
| Description | Optional help text that appears below the label. Available for Text Input, String Select, and File Upload fields. |
| Required | When enabled, users must provide a value for this field before they can submit the modal. Required fields automatically have a minimum selection of 1. |
| Field Order | Use the up/down arrow buttons to reorder fields. The order you set here is the order users will see them in the modal. |
Managing Modals
Once you've created modals, you can manage them from the Modals page:
Renaming Modals
Select a modal from the dropdown, then click "Rename Form" to change its internal name. This name is used for identification in the dashboard and when assigning modals to panels.
Editing Modal Title
The modal title is what users see at the top of the pop-up window. You can edit it in the "Form Title" field. Remember: this is limited to 45 characters.
Adding Fields
Click the "Add Field" button to add a new field to your modal. You can add up to 5 fields per modal (Discord's limit).
Deleting Fields
Click the trash icon on any field to remove it from the modal. Make sure to save your changes after deleting fields.
Saving Changes
After configuring your fields, click the "Save Changes" button to save your modal configuration. Your changes will be applied immediately.
Deleting Modals
Select a modal and click "Delete Modal Form" to permanently remove it. Warning: This action cannot be undone, and any panels using this modal will need to have their modal assignment removed.
Applying Modals to Panels
To make a modal appear when users click on a ticket panel button, you need to assign it to the panel:
Step 1: Create or Edit a Panel
Navigate to the Panels page and either create a new panel or edit an existing one.
Step 2: Find the Modal Field
In the panel configuration, scroll to the "Ticket Properties" section. You'll find a dropdown labeled "Modal" (or "Form" in some interfaces).
Step 3: Select Your Modal
Click the dropdown and select the modal you want to use. If you don't want a modal for this panel, select "No modal" (or leave it empty).
Step 4: Save the Panel
After selecting your modal, save the panel configuration. If the panel is already posted to Discord, you may need to update it for the changes to take effect.
How It Works
When a user clicks on a ticket panel button that has a modal assigned:
A modal window appears with all the fields you configured, displaying the modal title at the top.
The user fills out the form fields according to your configuration (required fields must be completed).
When the user submits the modal, a ticket channel is created.
The ticket channel displays an embed showing all the user's responses from the modal, making it easy for staff to see the information collected before the ticket was created.
Tip: Modal responses are displayed in the ticket channel as an embed with formatted fields, making it easy for staff to quickly understand the user's request. The responses are preserved in the ticket transcript when the ticket is closed.
Important: Modals are only available for ticket panels that create channels. Ensure your ticket panels are configured to create channels rather than threads.