DOCSEARCHbyAlgolia
Submit Docs

Ticket Tool Documentation

website·Indexed 34 days ago

https://docs.tickettool.xyz

Comprehensive guides for setting up and managing Ticket Tool, a ticketing system for Discord. Includes documentation on dashboard configurations for panels, categories, permissions, and transcripts, as well as a detailed list of slash commands and a troubleshooting database for resolving specific error hashes.

Tokens
33.2K
Snippets
61
Records
306
Agent score
60%

What's inside Ticket Tool

  2. Overview of Ticket Tool for Discord

    Ticket Tool is a support bot for Discord that facilitates the creation of private support channels, known as 'tickets', between a server's staff team and users seeking help. The bot is managed through a combination of a web-based Dashboard and Discord chat commands.

  3. Use General Server and Panel Variables

    General variables can be used across the ticket system to display information about the server, the current channel, or the ticket panel configuration.
    VariableDescription
    {server.name}Server name
    {server.id}Server ID
    {server.icon}Direct URL to server icon
    {server.banner}Direct URL to server banner
    {channel.name}Name of the channel where the variable is used
    {channel.id}ID of the channel where the variable is used
    {panel.count}Current count of the panel that triggered the message
    {panel.name}Name of the panel being used
    {panel.ticketLimit}Ticket limit for the current panel

  4. Use Ticket and Ticket Owner Variables

    Ticket variables provide information about the specific ticket channel and the user who created it. These variables only render when used within a ticket context. {ticket.owner} is an alias for {ticket.user} and supports the same sub-variables.
    VariableDescription
    {ticket}Mention of the ticket channel
    {ticket.id}ID of the ticket channel
    {ticket.user} / {ticket.owner}Mention of the user who created the ticket
    {ticket.user.name}Name of the ticket creator
    {ticket.user.id}ID of the ticket creator
    {ticket.user.nickname}Nickname of the ticket creator
    {ticket.user.icon}Direct URL of the ticket creator's profile picture
    {ticket.user.tag}4-digit discriminator of the ticket creator
    {ticket.user.full}Username + 4-digit discriminator of the ticket creator

  5. Use escalation variables in custom messages

    The following variables can be used within custom escalation messages to provide dynamic information about the transfer:
    VariableDescription
    {escalate.reason}The reason provided when using the /escalate command
    {escalate.panel}The number of the panel the ticket was escalated to
    {escalate.panel.X}Returns the text escalated when X is replaced by the number of the selected panel

  6. Use Ticket-Specific Variables

    Ticket variables are only functional within ticket channels. They provide details about the ticket itself and the user who opened it. Note that {ticket.owner} is an alias for {ticket.user} and shares the same sub-variables.
    {ticket}                - Mention of the ticket channel
{ticket.id}             - ID of the ticket channel
{ticket.user} / {ticket.owner} - Mention of the ticket creator
{ticket.user.name}     - Name of the ticket creator
{ticket.user.id}       - ID of the ticket creator
{ticket.user.nickname} - Nickname of the ticket creator
{ticket.user.icon}      - URL of the ticket creator's profile picture
{ticket.user.tag}      - 4-digit discriminator of the ticket creator
{ticket.user.full}     - Username + discriminator of the ticket creator

  7. Create a Multipanel by attaching multiple panels

    Multipanels allow you to combine multiple panels into a single message, where each attached panel contributes its buttons to the main panel. When a user clicks a button, a ticket is created based on the configuration of the panel that provided that button.

    Steps to create a multipanel:

    1. Create individual panels for every button you want displayed (e.g., one for 'User Reports', one for 'General Support').
    2. In the Panel Options of your primary panel, use the selection box in the 'Attached Panels' section to add the other panels.
    3. Send the primary panel to the desired channel.

    Constraints and Caveats:

    • Maximum of 25 panels can be combined into a single multipanel.
    • Do not attach a panel to itself (e.g., if editing the 'English' panel, do not add 'English' to the attached panels box) as this will create a duplicate button.
    • Only the primary panel's message is sent; attached panels only contribute their buttons.

  8. Use Custom Command Arguments for dynamic responses

    Command Arguments act as variables that capture user input provided after the trigger and inject it into the response. You can have up to 5 arguments per command.

    Usage:

    • Standalone: Use an argument variable on its own to create a 'say' command where the bot repeats the user's input.
    • Placeholder: Insert the argument variable within a predefined sentence to create a template.
    • Separators: If using multiple arguments, you can define a separator character (default is ,). Text before the separator is assigned to {argument.1}, text after to {argument.2}, and so on.

  9. Use Custom Command Arguments as variables

    Command Arguments act as variables that capture text provided after the trigger in a user's message. You can have up to 5 arguments per command.

    Usage:

    • Standalone: Use an argument variable alone to create a 'say' command where the bot repeats the user's input.
    • Placeholders: Embed the argument variable within a predefined message to inject user input into a template.

    Argument Separators: By default, arguments are separated by a comma (,). Text before the first separator is {argument.1}, text after is {argument.2}, and so on. This separator character can be customized in the dashboard.

  10. Access and configure Transcript Options

    To manage how ticket transcripts are saved and delivered, navigate to the Ticket Tool Dashboard, select your server, go to the 'Panel Configs' tab, and locate 'Transcript Options' under the Advanced Settings section. Ensure you save changes using the pop-up notification after making adjustments.

  11. Configure DropDown Style for ticket creation

    Dropdowns allow you to display several ticket panels within a single select menu. To access these settings:

    1. Go to the Ticket Tool Dashboard.
    2. Select your server.
    3. Navigate to the Panel Configs tab.
    4. Under Panel Settings, select DropDown Style Options.

  12. Create message-based automations in the Automation Editor

    The 'Check for message' automation monitors tickets for the presence or absence of messages.

    Configuration Parameters:

    • Check type: Determine if a message is found within X time or NOT found within X time.
    • From: Specify the author to check for: Anyone, the Ticket Owner ({ticket.user}), or the Support Team.
    • For: The time frame in seconds. The minimum allowed value is 5 minutes (values lower than this default to 5 minutes).
    • Check frequency: Choose between 'Once and stop' or 'Until stopped'.
    • Action: If the condition is met, the bot can send a Custom Command, Close the ticket, or Delete the ticket.

    Advanced Options (Show Advanced Automation):

    • Timer behavior: If a message is found, the timer can either restart or continue (only available for 'not found within X time' checks).
    • Post-action behavior: Define if the bot should keep or continue checking after the action runs.