Reddit Connector
The Reddit connector streams new submissions from any subreddit to one or more of the webhooks configured in your Discord server.
See also
A step-by-step walkthrough: Configuring a Social Connector.
The connector posts through Discord webhooks, so you need to know how they work. See this official guide for an introduction.
By default each submission is posted with the subreddit name (prefixed with /r/) as author and the subreddit mobile icon (if present) as the Discord profile picture. You can customize these settings and others for each stream.
The post permalink goes to Discord, and the submission preview uses Discord's own parsing of Reddit content.
Note
This module is a free alternative to services that usually require payment. The free Reddit API has limits, so posts can arrive late (new posts are checked every 5~15 minutes) and a busy subreddit can lose a few (each check picks up at most 100 new posts).
Warning
The Reddit API is inconsistent in places, so the module runs checks to avoid duplicate posts. Those checks work less well right after you add a subreddit and improve over time.
Managing Reddit feeds
You add, edit, remove and list Reddit feeds from your server's Reddit page on this dashboard; there is no Discord command for it any more.
When you add a feed you pick the subreddit and the channel to post to, and the dashboard creates the Discord webhook for you (this needs GiselleBot to have "Manage Webhooks" permission in that channel). The customization options below are fields on the feed's form.
Customization options
NSFW handling
Reddit submissions might be natively flagged as "NSFW".
The NSFW setting has 3 modes:
- censor posts a NSFW URL wrapped in
< >angle brackets, which stops Discord from auto-embedding it. The same applies to the content URL if the header uses that placeholder; see the header field below. - skip drops NSFW-flagged items.
- only posts NSFW-flagged items and skips everything else, uncensored. Use it for a second, NSFW-only stream alongside a clean one.
Note
The check depends on the author, or a fast moderator, flagging the submission as NSFW. If you know the subreddit is safe for work, you can skip it.
Default: false (both SFW and NSFW items are posted uncensored), or censor if the NSFW option is enabled without picking a specific mode.
Flair filtering
Adds a whitelist (inclusive) filter for submission flairs. Posts whose flair matches one of the selected flairs go to the webhook; the rest are skipped.
Enter a comma-separated list on the Reddit page's Filter Flairs field - a multi-word flair like Weekly Discussion is just its own comma-separated entry, no quoting needed. All filters are case-insensitive.
Warning
This only works for flairs that already exist when the subreddit is checked. Flairs added later may not work.
Content type filtering
Limits the stream to certain kinds of submission. Tick any combination of text, image, link and video on the Reddit page's Filter by Content Type row, or leave all unticked to post everything.
Each post gets exactly one type, checked in this order: video (Reddit marks it as such), then image, then text (self) post, then link. If the type cannot be determined, the post is posted anyway; a failed classification never hides content.
Default: No filter
Keyword filtering
Adds a whitelist filter. If the submission contains first word and/or (see below) second word, it goes to the webhook; otherwise it is ignored. Enter a comma-separated list on the Reddit page's Filter Words field, case-insensitive - a multi-word phrase is just its own comma-separated entry, no quoting needed.
The filter works on partial words (e.g. "announce" will work on both "announcement" and "announced").
Default: No filter
Filter match mode
Sets how the whitelist behaves when it has more than 1 word.
ANDwill only allow submissions that contain all of the filtered words.ORwill allow submissions that contain at least one of the filtered words.
Default: OR
Include vs. exclude filtering
Sets whether the filter includes or excludes the words.
- Include will only allow submissions that contain the filtered word(s).
- Exclude will only allow submissions that do not contain the filtered word(s).
Combined with the filter match mode, this lets the connector include a submission when at least one filter item matches (OR) or all do (AND), or exclude on the same logic: post when all items are absent (AND) or when at least one is absent (OR).
Default: Include
Note
Include takes priority over Exclude, but the form only lets you pick one.
Custom header message
Sets the message template used when submissions are posted. Custom headers take at most 1024 characters.
Custom headers are plain text. For a formatted card, fill in the Embed Header fields on the feed's page instead: title, description, colour, image, thumbnail, footer and author. When any of them is set, the item is posted as an embed instead of plain text.
Placeholders (such as %title% or %author%) work in every embed field, and a title containing quotes or special characters is posted exactly as written. The old "embed JSON" syntax that broke on special characters is no longer needed or documented. If a feed still carries an old JSON header, its page shows the saved value with a note and the embed fields to replace it.
Custom headers support these dynamic tags, replaced at run time:
- %subreddit%: the subreddit "technical" name, excluding any prefix (
/r/orr/) (e.g.askreddit) - %subreddit_fullname%: the subreddit "display" name (e.g.
Ask Reddit...) - %author%: the Reddit account name of the post author, excluding any prefix (
/u/oru/) (e.g.cycloptux) - %title%: the title of the submission (e.g.
Without saying what the category is, what are your top five?) - %flair%: the name of the flair assigned to the post, if present, or None if no flair is assigned
- %content_url%: the "URL" parameter of a post, which is a link to the comments for a text post, or the URL of the content (image, video, link...) otherwise
- %timestamp% or %timestamp_utc%: the submission creation time in UTC, with format
YYYY-MM-DD HH:mm:ss (UTC). - %timestamp_iso%: the submission creation time in UTC, as an ISO8601 string.
- %timestamp_pst%: the submission creation time in PST, with format
YYYY-MM-DD HH:mm:ss (PST). - %url%: the Reddit post permalink URL. See below for more info.
Timestamp tags accept a custom time zone. Replace the utc part with either:
A different valid IANA time zone identifier (e.g. America/New_York, Europe/London).
An UTC offset in the form
[UTC/GMT](+/-)(hours)[:][minutes], for example:- %timestamp_Europe/London%
- %timestamp_America/Los_Angeles%
- %timestamp_Japan%
- %timestamp_PST8PDT%
- %timestamp_+0800%
- %timestamp_-10:30%
- %timestamp_UTC+2%
Without %url%, the Reddit post permalink is appended after every header on a new line, and Discord renders it.
If the %url% parameter is used, the default URL will not be appended to the custom header.
Default: New submission in /r/%subreddit% from /u/%author%!
Custom webhook name
Sets a custom username on the webhook when submissions are posted. Custom usernames take at most 32 characters.
Default: New submissions are posted by a webhook named after the subreddit, with the /r/ prefix included
Keep the webhook's default username
Removes any custom name from the webhook. The real webhook name (the one you assigned when creating the webhook in Discord) will be used.
Default: false (Custom or automated names will be applied)
Keep the webhook's default avatar
Removes any custom avatar from the webhook. The real webhook avatar (the one you assigned when creating the webhook in Discord) will be used.
Default: false (Automated avatars will be applied)
Permissions Needed
User: Manage Webhooks
Editing a feed
Editing a feed on the Reddit page replaces all of its customization options with what you set in the edit form. It is not a partial update, so check the current settings before you change them.
Permissions needed on the dashboard: Manage Webhooks (server-side)
Removing a feed
Removing a feed on the Reddit page stops the stream and removes its link to the server webhook.
Listing feeds
The Reddit page lists every Reddit stream currently linked to a webhook in the server.