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.autoresponder (2.0.0)

Download OpenAPI specification:Download

Settings

Operations related to the settings of the autoresponder module

Delete The Settings Of The Autoresponder Module In A Server

Delete the settings for Husqy autoresponder 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 autoresponder module

Get The Status Of The Reactionroles Module

Status endpoint for the Husqy.modules.autoresponder microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Disable The Autoresponder Module

Enable the autoresponder 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": {
    }
}

Enable The Autoresponder Module

Enable the autoresponder 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": {
    }
}

Triggers

Operations related to autoresponder triggers

Get The Triggers In The Server

Get the triggers for Husqy autoresponder module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Create A New Trigger

Create a new trigger for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
trigger_type
required
integer (Trigger Type)
match_case
required
boolean (Match Case)
Trigger (string) or Trigger (null) (Trigger)
Array of Allowed Channel Ids (integers) or Allowed Channel Ids (null) (Allowed Channel Ids)
Array of Ignored Channel Ids (integers) or Ignored Channel Ids (null) (Ignored Channel Ids)
Array of Allowed Role Ids (integers) or Allowed Role Ids (null) (Allowed Role Ids)
Array of Ignored Role Ids (integers) or Ignored Role Ids (null) (Ignored Role Ids)
Array of Response Ids (strings) or Response Ids (null) (Response Ids)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "trigger_type": 0,
  • "match_case": true,
  • "trigger": "string",
  • "allowed_channel_ids": [
    ],
  • "ignored_channel_ids": [
    ],
  • "allowed_role_ids": [
    ],
  • "ignored_role_ids": [
    ],
  • "response_ids": [
    ]
}

Response samples

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

Get The Configuration Of A Trigger

Get the response for Husqy autoresponder module for a guild.

path Parameters
trigger_id
required
string (Trigger Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete The Configuration Of A Trigger

Delete the trigger for Husqy autoresponder module for a guild.

path Parameters
trigger_id
required
string (Trigger 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 The Configuration Of A Trigger

Update the reactionrole panel for Husqy autoresponder module for a guild.

path Parameters
trigger_id
required
string (Trigger Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Trigger Type (integer) or Trigger Type (null) (Trigger Type)
Match Case (boolean) or Match Case (null) (Match Case)
Trigger (string) or Trigger (null) (Trigger)
Array of Allowed Channel Ids (integers) or Allowed Channel Ids (null) (Allowed Channel Ids)
Array of Ignored Channel Ids (integers) or Ignored Channel Ids (null) (Ignored Channel Ids)
Array of Allowed Role Ids (integers) or Allowed Role Ids (null) (Allowed Role Ids)
Array of Ignored Role Ids (integers) or Ignored Role Ids (null) (Ignored Role Ids)
Array of Response Ids (strings) or Response Ids (null) (Response Ids)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "trigger_type": 0,
  • "match_case": true,
  • "trigger": "string",
  • "allowed_channel_ids": [
    ],
  • "ignored_channel_ids": [
    ],
  • "allowed_role_ids": [
    ],
  • "ignored_role_ids": [
    ],
  • "response_ids": [
    ]
}

Response samples

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

Check A Message For A Trigger

Create a new panel for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
origin_message_id
required
integer (Origin Message Id)
channel_id
required
integer (Channel Id)
member_roles
required
Array of integers (Member Roles)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "origin_message_id": 0,
  • "channel_id": 0,
  • "member_roles": [
    ]
}

Response samples

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

Responses

Operations related to a autoresponder responses

Get The Responses In The Server

Get the responses for Husqy autoresponder module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Create A New Response

Create a new response for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
response_type
required
integer (Response Type)
Response Content (string) or Response Content (null) (Response Content)
Emoji Name (string) or Emoji Name (null) (Emoji Name)
Emoji Id (string) or Emoji Id (null) (Emoji Id)

Responses

Request samples

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

Response samples

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

Get The Configuration Of A Response

Get the response for Husqy autoresponder module for a guild.

path Parameters
response_id
required
string (Response Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete The Configuration Of A Response

Delete the response for Husqy autoresponder module for a guild.

path Parameters
response_id
required
string (Response 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": {
    }
}

Privacy

Operations for a users privacy data

Get The Privacy Data Of A User For The Husqy.Modules.Autoresponder 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.Autoresponder 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.Autoresponder Microservice

Home endpoint for the Husqy.modules.autoresponder microservice.

Responses

Response samples

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