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

Download OpenAPI specification:Download

Settings

Operations related to the settings of the rules module

Get The Settings Of The Rules Module In A Server

Get the settings for Husqy rules module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete The Settings Of The Rules Module In A Server

Delete the settings for Husqy rules 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": {
    }
}

Update The Settings Of The Rules Module In A Server

Change the settings for Husqy rules module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Rules Channel (integer) or Rules Channel (string) or Rules Channel (null) (Rules Channel)
Rules Actions Enabled (boolean) or Rules Actions Enabled (null) (Rules Actions Enabled)
Array of Rules Accepted Role Ids (integers) or Rules Accepted Role Ids (null) (Rules Accepted Role Ids)
Rules Denied Action (integer) or Rules Denied Action (null) (Rules Denied Action)
Array of Rules Denied Role Ids (integers) or Rules Denied Role Ids (null) (Rules Denied Role Ids)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "rules_channel": 0,
  • "rules_actions_enabled": true,
  • "rules_accepted_role_ids": [
    ],
  • "rules_denied_action": 0,
  • "rules_denied_role_ids": [
    ]
}

Response samples

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

Status

Operations related to the status of the rules module

Get The Status Of The Rules Module In A Server

Status endpoint for the Husqy.modules.rules microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Enable The Rules Module In A Server

Enable the rules 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 Rules Module

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

Rules

Operations related to rules entries

Get All Current Rules Entries In A Server

Get the entry for Husqy rules module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Create A New Rule

Get the response for Husqy rules module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
rule_text
required
string (Rule Text)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

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

Response samples

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

Get The Info About A Rule

Get the response for Husqy rules module for a guild.

path Parameters
entry_id
required
string (Entry Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete A Rule

Get the response for Husqy rules module for a guild.

path Parameters
entry_id
required
string (Entry Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Application Id (integer) or Application Id (null) (Application Id)
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": {
    }
}

Check

Operations related to rules interactions entries

Check If The Rules Of The Server Need To Be Interaction

Handle a verification for Husqy verifier module for a guild.

Request Body schema: application/json
required
message_id
required
integer (Message Id)
channel_id
required
integer (Channel Id)
interaction_custom_id
required
string (Interaction Custom Id)
interaction_id_token
required
string (Interaction Id Token)
application_id
required
integer (Application Id)

Responses

Request samples

Content type
application/json
{
  • "message_id": 0,
  • "channel_id": 0,
  • "interaction_custom_id": "string",
  • "interaction_id_token": "string",
  • "application_id": 0
}

Response samples

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

Check If The Rules Of The Server Need To Be Send

Handle a verification for Husqy verifier module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Requester (integer) or Requester (null) (Requester)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

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

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.Rules 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.Rules 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.Rules Microservice

Home endpoint for the Husqy.general microservice.

Responses

Response samples

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