Documentation

Learn TicketsX faster

Setup guides, the full command reference, Premium features, and the REST API in one place.

Rate Limits & Safety

The API is built so that a token can never be used to abuse a server, even if it leaks. The following protections apply to every request.

  • No mass pings. All API-driven messages (including webhook messages and tags) have @everyone, @here, and arbitrary role mentions disabled. Only a panel’s configured mention role and the ticket creator can be pinged when opening a ticket.
  • No impersonation. Webhook display names containing reserved words like "discord" or "clyde" are replaced, and avatar overrides must be valid https:// URLs.
  • Rate limits. Each token is rate limited per action (for example: open ticket 10/min, send message 30/min, rename 2/10min, reads 120/min). Exceeding a limit returns 429 with a retry_after value in seconds. Call GET /api/token for the live table.
  • Open-ticket cap. The API will not open new tickets once a server reaches its open-ticket safety cap, and it refuses to open tickets for blacklisted users.
  • Least privilege. Sensitive permissions (Read Ticket Messages, View Transcripts, Use Tags, Rename Tickets) are off by default and must be explicitly enabled per token.
  • Expiry & rotation. Tokens can be given an expiry, disabled, or rotated from the dashboard; rotating immediately invalidates the previous secret.
  • Guild scoping. A token only works for the single server it was created in; every request is re-checked against that server.