The Husqy premium subscription is now live! Please head over to our Discord store page to get started!
We are verified! Husqy is a verified bot in Discord making us visible in the app discovery and enabling bigger trust to users!
Want to help us translate the Husqy responses? We can't do it without you! Please visit our translations repo!
Skip to main content
API docs by Redocly

Husqy.modules.tickets (2.0.0)

Download OpenAPI specification:Download

Settings

Operations related to the settings of the tickets module

Delete The Settings Of The Tickets Module In A Server

Delete the settings for Husqy tickets module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Status

Operations related to the status of the tickets module

Get The Status Of The Tickets Module In A Server

Status endpoint for the Husqy.modules.tickets microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enable The Tickets Module

Enable the tickets module for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Disable The Tickets Module

Enable the tickets module for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Panels

Operations related to ticket panels

Get All Ticket Panels In A Server

Get the panels for Husqy tickets module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create A New Ticket Type For A Panel

Get the response for Husqy tickets module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
panel_type
required
string (Panel Type)
create_message_is_embed
required
boolean (Create Message Is Embed)
create_message_content
required
string (Create Message Content)
form_enabled
required
boolean (Form Enabled)
Form Content (string) or Form Content (null) (Form Content)
ticket_opened_message_is_embed
required
boolean (Ticket Opened Message Is Embed)
threads_enabled
required
boolean (Threads Enabled)
ticket_opened_message_content
required
string (Ticket Opened Message Content)
ticket_opened_name
required
string (Ticket Opened Name)
required
Support Engineer Role Id (integer) or Support Engineer Role Id (string) (Support Engineer Role Id)
required
Create Message Category Id (integer) or Create Message Category Id (string) (Create Message Category Id)
required
Create Message Channel Id (integer) or Create Message Channel Id (string) (Create Message Channel Id)
Array of Open Tickets Categories (integers) or Open Tickets Categories (null) (Open Tickets Categories)
Array of Closed Tickets Categories (integers) or Closed Tickets Categories (null) (Closed Tickets Categories)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "panel_type": "string",
  • "create_message_is_embed": true,
  • "create_message_content": "string",
  • "form_enabled": true,
  • "form_content": "string",
  • "ticket_opened_message_is_embed": true,
  • "threads_enabled": true,
  • "ticket_opened_message_content": "string",
  • "ticket_opened_name": "string",
  • "support_engineer_role_id": 0,
  • "create_message_category_id": 0,
  • "create_message_channel_id": 0,
  • "open_tickets_categories": [
    ],
  • "closed_tickets_categories": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Configuration Of A Panel

Get the response for Husqy tickets module for a guild.

path Parameters
panel_id
required
string (Panel Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete A Ticket Panel

Get the response for Husqy tickets module for a guild.

path Parameters
panel_id
required
string (Panel Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Edit A Ticket Panel

Get the response for Husqy tickets module for a guild.

path Parameters
panel_id
required
string (Panel Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Panel Type (string) or Panel Type (null) (Panel Type)
Create Message Is Embed (boolean) or Create Message Is Embed (null) (Create Message Is Embed)
Create Message Content (string) or Create Message Content (null) (Create Message Content)
Form Enabled (boolean) or Form Enabled (null) (Form Enabled)
Form Content (string) or Form Content (null) (Form Content)
Ticket Opened Message Is Embed (boolean) or Ticket Opened Message Is Embed (null) (Ticket Opened Message Is Embed)
Threads Enabled (boolean) or Threads Enabled (null) (Threads Enabled)
Ticket Opened Message Content (string) or Ticket Opened Message Content (null) (Ticket Opened Message Content)
Ticket Opened Name (string) or Ticket Opened Name (null) (Ticket Opened Name)
Support Engineer Role Id (integer) or Support Engineer Role Id (null) (Support Engineer Role Id)
Array of Open Tickets Categories (integers) or Open Tickets Categories (null) (Open Tickets Categories)
Array of Closed Tickets Categories (integers) or Closed Tickets Categories (null) (Closed Tickets Categories)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "panel_type": "string",
  • "create_message_is_embed": true,
  • "create_message_content": "string",
  • "form_enabled": true,
  • "form_content": "string",
  • "ticket_opened_message_is_embed": true,
  • "threads_enabled": true,
  • "ticket_opened_message_content": "string",
  • "ticket_opened_name": "string",
  • "support_engineer_role_id": 0,
  • "open_tickets_categories": [
    ],
  • "closed_tickets_categories": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Configuration Of All Ticket Types Of A Panel

Get the response for Husqy tickets module for a guild.

path Parameters
panel_id
required
string (Panel Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create A New Ticket Type For A Panel

Get the response for Husqy tickets module for a guild.

path Parameters
panel_id
required
string (Panel Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
title
required
string (Title)
Description (string) or Description (null) (Description)
Emoji Id (string) or Emoji Id (null) (Emoji Id)
Emoji Name (string) or Emoji Name (null) (Emoji Name)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "title": "string",
  • "description": "string",
  • "emoji_id": "string",
  • "emoji_name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Configuration Of A Panels Ticket Type

Get the response for Husqy tickets module for a guild.

path Parameters
panel_id
required
string (Panel Id)
ticket_type_id
required
string (Ticket Type Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete A Ticket Type From A Panel

Get the response for Husqy tickets module for a guild.

path Parameters
panel_id
required
string (Panel Id)
ticket_type_id
required
string (Ticket Type Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Tickets

Operations related to a tickets

Get All Tickets

Get the response for Husqy tickets module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Information About A Ticket

Get the response for Husqy tickets module for a guild.

path Parameters
ticket_id
required
string (Ticket Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete A Ticket

Get the response for Husqy tickets module for a guild.

path Parameters
ticket_id
required
string (Ticket Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
required
Application Id (integer) or Application Id (null) (Application Id)
required
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Claim A Ticket And Become The Current Support Engineer

Get the response for Husqy tickets module for a guild.

path Parameters
ticket_id
required
string (Ticket Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
required
Application Id (integer) or Application Id (null) (Application Id)
required
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Close An Open Ticket

Get the response for Husqy tickets module for a guild.

path Parameters
ticket_id
required
string (Ticket Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
required
Application Id (integer) or Application Id (null) (Application Id)
required
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reopen An Open Ticket

Get the response for Husqy tickets module for a guild.

path Parameters
ticket_id
required
string (Ticket Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
required
Application Id (integer) or Application Id (null) (Application Id)
required
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Transfer An Open Ticket

Get the response for Husqy tickets module for a guild.

path Parameters
ticket_id
required
string (Ticket Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
new_engineer
required
integer (New Engineer)
required
Application Id (integer) or Application Id (null) (Application Id)
required
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "new_engineer": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Transcribe An Open Ticket

Get the response for Husqy tickets module for a guild.

path Parameters
ticket_id
required
string (Ticket Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
required
Application Id (integer) or Application Id (null) (Application Id)
required
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Messages Send Related To A Ticket

Get the response for Husqy tickets module for a guild.

query Parameters
guild_id
required
integer (Guild Id)
ticket_id
required
string (Ticket Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Messages Related To A Ticket

Post the response for Husqy tickets module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
channel_id
required
integer (Channel Id)
message_id
required
integer (Message Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "channel_id": 0,
  • "message_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete A Message Related To A Ticket

Delete the response for Husqy tickets module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
channel_id
required
integer (Channel Id)
message_id
required
integer (Message Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "channel_id": 0,
  • "message_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Events

Operations related to a ticket events

Start Creation Of A New Ticket

Start creating a new ticket (if form is enabled, ticket will be fully created on events/handle-form).

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
panel_id
required
string (Panel Id)
ticket_type_id
required
string (Ticket Type Id)
required
Application Id (integer) or Application Id (null) (Application Id)
token
required
string (Token)
interaction_id
required
integer (Interaction Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "panel_id": "string",
  • "ticket_type_id": "string",
  • "application_id": 0,
  • "token": "string",
  • "interaction_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Start Creation Of A New Ticket

Start creating a new ticket (if form is enabled, ticket will be fully created on events/handle-form).

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
panel_id
required
string (Panel Id)
ticket_type_id
required
string (Ticket Type Id)
required
Application Id (integer) or Application Id (null) (Application Id)
required
Array of objects (Values)
token
required
string (Token)
interaction_id
required
integer (Interaction Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "panel_id": "string",
  • "ticket_type_id": "string",
  • "application_id": 0,
  • "values": [
    ],
  • "token": "string",
  • "interaction_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Privacy

Operations for a users privacy data

Get The Privacy Data Of A User For The Husqy.Modules.Welcoming Microservice

Get user entries.

query Parameters
guild_id
required
integer (Guild Id)
privacy_member_id
required
integer (Privacy Member Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete The Privacy Data Of A User For The Husqy.Modules.Welcoming Microservice

Delete user entries.

query Parameters
guild_id
required
integer (Guild Id)
privacy_member_id
required
integer (Privacy Member Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Home Endpoint For The Husqy.Modules.Tickets Microservice

Home endpoint for the Husqy.modules.tickets microservice.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}