Skip to main content

🏁 Getting Started

Welcome to the Open Ticket API Reference! This part of the documentation provides in-depth information on the various config variables, commands, classes, types, interfaces, events and utilities available in Open Ticket.

Most references are targeted towards users who want to develop plugins for Open Ticket. An in-depth guide for this can be found here.

API Reference

Configs, Commands, Classes, Types & more!

version compatibility

This API Reference is for Open Ticket v4.0.0.

  • Older and newer versions may include changes, additions, or deprecated features.

📌 Table Of Contents​

The API Reference consists of several categories to help you navigate the bot’s functionality efficiently:

  • Languages: A list of all available languages.
  • Commands: Detailed documentation on every available command.
  • Config: Information on all JSON configuration files.
  • Events: Documentation for every Open Ticket event.
  • Classes: Descriptions of API classes and their usage.
  • Interfaces: Interfaces available for advanced customizations.
  • Types: Type aliases used in the API.
  • Enums: Various enumerations for options and settings.
  • Utilities: Helpful utility functions for promise handling, date formatting, and more.

🚀 Getting Started​

To get started, familiarize yourself with the Config and Commands sections first. These are the core functionalities for setting up and managing Open Ticket in your Discord server.

🔧 Configuration​

You can configure Open Ticket using the 5 JSON files available in ./config/. Learn more:

🖥️ Commands​

Open Ticket provides a variety of commands to manage tickets. Learn more:

  • /add - Add a user to a ticket.
  • /remove - Remove a user from a ticket.
  • /rename - Rename the ticket channel name.
  • /move - Move the ticket to a different option type.
  • /clear - Delete multiple tickets at the same time.
  • /autoclose - Manage the autoclose system.
  • /autodelete - Manage the autodelete system.
  • /blacklist - Manage blacklisted users.
  • /stats - View ticket system statistics.

📚 Additional Resources​

Need more help? Explore some of our additional resources and articles: