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

Download OpenAPI specification:Download

Settings

Operations related to the settings of the welcoming module

Get The Settings Of The Welcoming Module In A Server

Get the settings for Husqy welcoming module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Update The Settings Of The Logging Module In A Server

Change the settings for Husqy welcoming module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Welcome Messages Dm Enabled (boolean) or Welcome Messages Dm Enabled (null) (Welcome Messages Dm Enabled)
Welcome Messages Enabled (boolean) or Welcome Messages Enabled (null) (Welcome Messages Enabled)
Welcome Messages Randomized (boolean) or Welcome Messages Randomized (null) (Welcome Messages Randomized)
Welcome Messages Channel (integer) or Welcome Messages Channel (null) (Welcome Messages Channel)
Leave Messages Enabled (boolean) or Leave Messages Enabled (null) (Leave Messages Enabled)
Leave Messages Randomized (boolean) or Leave Messages Randomized (null) (Leave Messages Randomized)
Leave Messages Channel (integer) or Leave Messages Channel (null) (Leave Messages Channel)
Autorole Enabled (boolean) or Autorole Enabled (null) (Autorole Enabled)
Array of Autorole Role Ids (integers) or Autorole Role Ids (null) (Autorole Role Ids)
Timedroles Enabled (boolean) or Timedroles Enabled (null) (Timedroles Enabled)
Welcome Messages Dm Randomized (boolean) or Welcome Messages Dm Randomized (null) (Welcome Messages Dm Randomized)
Welcome Message Dm Response Id (string) or Welcome Message Dm Response Id (null) (Welcome Message Dm Response Id)
Welcome Message Response Id (string) or Welcome Message Response Id (null) (Welcome Message Response Id)
Leave Message Response Id (string) or Leave Message Response Id (null) (Leave Message Response Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "welcome_messages_dm_enabled": true,
  • "welcome_messages_enabled": true,
  • "welcome_messages_randomized": true,
  • "welcome_messages_channel": 0,
  • "leave_messages_enabled": true,
  • "leave_messages_randomized": true,
  • "leave_messages_channel": 0,
  • "autorole_enabled": true,
  • "autorole_role_ids": [
    ],
  • "timedroles_enabled": true,
  • "welcome_messages_dm_randomized": true,
  • "welcome_message_dm_response_id": "string",
  • "welcome_message_response_id": "string",
  • "leave_message_response_id": "string"
}

Response samples

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

Delete The Settings Of The Welcoming Module In A Server

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

Get The Status Of The Welcoming Module In A Server

Status endpoint for the Husqy.modules.welcoming microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Disable The Welcoming Module In A Server

Enable the welcoming 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 Welcoming Module In A Server

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

Responses

Operations related to responses

Get Information About A Response In A Server

Get the response for Husqy welcoming 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 A Welcoming Response In A Server

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

Get The Welcoming Module Responses In A Server

Get the responses for Husqy welcoming module for a guild.

query Parameters
guild_id
required
integer (Guild Id)
Response Type (integer) or Response Type (null) (Response Type)

Responses

Response samples

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

Create A New Welcoming Response In A Server

Create a response for Husqy welcoming module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
response_type
required
integer (Response Type)
is_embed
required
boolean (Is Embed)
content
required
string (Content)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "response_type": 0,
  • "is_embed": true,
  • "content": "string"
}

Response samples

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

Timedroles

Operations related to timedroles

Get Information About A Timedrole In A Server

Get the timedrole for Husqy welcoming module for a guild.

path Parameters
timedrole_id
required
string (Timedrole Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete A Timedroles In A Server

Delete the timedrole for Husqy welcoming module for a guild.

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

Get The Timedroles In A Server

Get the timedroles for Husqy welcoming module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Create A New Timedrole In A Server

Create a response for Husqy welcoming module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
role_id
required
integer (Role Id)
add_after
required
integer (Add After)

Responses

Request samples

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

Response samples

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

Checks

Operations related to checking server events

Check If A Welcoming Message Needs To Be Send To The Users Dm

Create a response for Husqy welcoming 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": {
    }
}

Check If A Welcoming Message Needs To Be Send To The Welcoming Channel

Create a response for Husqy welcoming 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": {
    }
}

Check If A Leave Message Needs To Be Send To The Leave Channel

Create a response for Husqy welcoming 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": {
    }
}

Check If The Autorole Roles Need To Be Added To The User

Check autoroles for Husqy welcoming 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": {
    }
}

Check If A Timedrole Needs To Be Added To A User

Check a timedrole for Husqy welcoming module for a guild.

Responses

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

Home endpoint for the Husqy.general microservice.

Responses

Response samples

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