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

Download OpenAPI specification:Download

Settings

Operations related to the settings of the socials module

Get The Settings Of The Socials Module In A Server

Get the settings for Husqy socials 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 Socials Module In A Server

Change the settings for Husqy socials module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Monitor Reddit (boolean) or Monitor Reddit (null) (Monitor Reddit)
Monitor Rss (boolean) or Monitor Rss (null) (Monitor Rss)
Monitor Twitch (boolean) or Monitor Twitch (null) (Monitor Twitch)
Monitor Youtube (boolean) or Monitor Youtube (null) (Monitor Youtube)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "monitor_reddit": true,
  • "monitor_rss": true,
  • "monitor_twitch": true,
  • "monitor_youtube": true
}

Response samples

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

Delete The Settings Of The Socials Module In A Server

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

Get The Status Of The Socials Module

Status endpoint for the Husqy.modules.welcoming microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Enable The Socials Module In A Server

Enable the socials 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 Socials Module In A Server

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

Memes

Operations related to memes

Update A Discord Message Sent By Husqy With A Meme

Status endpoint for the Husqy.modules.welcoming microservice.

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

Reddit

Operations related to the Reddit component of the socials module

Get The Monitored Subreddits In The Server

Get the creation channels for Husqy socials module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete A Subreddit From The Monitored Subreddits In The Server

Get the creation channels for Husqy socials module for a guild.

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

Responses

Request samples

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

Response samples

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

Add A Subreddit To The Monitor Reddit List

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
subreddit
required
string (Subreddit)
target_channel_id
required
integer (Target Channel Id)
mention_everyone
required
boolean (Mention Everyone)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "subreddit": "string",
  • "target_channel_id": 0,
  • "mention_everyone": true
}

Response samples

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

Send A New Post Of A Subreddit To The Channel

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
subreddit
required
string (Subreddit)
url
required
string (Url)

Responses

Request samples

Content type
application/json
{
  • "subreddit": "string",
  • "url": "string"
}

Response samples

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

RSS

Operations related to the RSS component of the socials module

Get The Monitored Rss Feeds In The Server

Get the creation channels for Husqy socials module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete A Rss Feed From The Monitored Rss Feeds In The Server

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
rss_feed
required
string (Rss Feed)

Responses

Request samples

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

Response samples

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

Add An Rss Feed To The Monitor Rss List

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
rss_feed
required
string (Rss Feed)
target_channel_id
required
integer (Target Channel Id)
mention_everyone
required
boolean (Mention Everyone)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "rss_feed": "string",
  • "target_channel_id": 0,
  • "mention_everyone": true
}

Response samples

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

Send A New Entry Of An Rss Feed To The Channel

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
rss_feed_url
required
string (Rss Feed Url)
entry_title
required
string (Entry Title)
entry_description
required
string (Entry Description)

Responses

Request samples

Content type
application/json
{
  • "rss_feed_url": "string",
  • "entry_title": "string",
  • "entry_description": "string"
}

Response samples

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

Twitch

Operations related to the Twitch component of the socials module

Get The Monitored Twitch Accounts In The Server

Get the creation channels for Husqy socials module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete A Subtwitch From The Monitored Subtwitchs In The Server

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
twitch_account
required
string (Twitch Account)

Responses

Request samples

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

Response samples

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

Add A Subtwitch To The Monitor Twitch List

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
twitch_account
required
string (Twitch Account)
target_channel_id
required
integer (Target Channel Id)
mention_everyone
required
boolean (Mention Everyone)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "twitch_account": "string",
  • "target_channel_id": 0,
  • "mention_everyone": true
}

Response samples

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

Send A Message To The Channel When A Twitch Account Goes Live

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
twitch_account
required
string (Twitch Account)

Responses

Request samples

Content type
application/json
{
  • "twitch_account": "string"
}

Response samples

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

YouTube

Operations related to the YouTube component of the socials module

Get The Monitored Youtube Channels In The Server

Get the creation channels for Husqy socials module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete A Youtube Channel From The Monitored Youtube Channel List In The Server

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
youtube_channel_handle
required
string (Youtube Channel Handle)

Responses

Request samples

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

Response samples

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

Add A Youtube Channel To The Monitor Youtube Channel List

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
youtube_channel_handle
required
string (Youtube Channel Handle)
target_channel_id
required
integer (Target Channel Id)
mention_everyone
required
boolean (Mention Everyone)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "youtube_channel_handle": "string",
  • "target_channel_id": 0,
  • "mention_everyone": true
}

Response samples

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

Send A New Post Of A Youtube Channel To The Channel

Get the creation channels for Husqy socials module for a guild.

Request Body schema: application/json
required
uploads_playlist_id
required
string (Uploads Playlist Id)
video_id
required
string (Video Id)
video_title
required
string (Video Title)

Responses

Request samples

Content type
application/json
{
  • "uploads_playlist_id": "string",
  • "video_id": "string",
  • "video_title": "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.Socials 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.Socials Microservice

Home endpoint for the Husqy.general microservice.

Responses

Response samples

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