Skip to main content

Search GiselleBot's commands and docs.

Try /ban, or start with / for commands only.

Press Ctrl K anywhere in the dashboard to open this.

RSS Reader

The RSS (Really Simple Syndication) reader streams new items from any RSS (XML, Atom) feed to one or more of the webhooks configured in your Discord server.

See also

A step-by-step walkthrough: Configuring a Social Connector.

The reader posts through Discord webhooks, so you need to know how they work. See this official guide for an introduction.

By default each item is posted with the RSS feed name (if the feed has one, otherwise the website URL or the feed URL) as author and the feed image (if present, otherwise a default RSS logo) as the Discord profile picture. You can customize these settings and others for each stream.

The item URL from the feed goes to Discord, and the item preview uses Discord's own parsing of web content.

Note

This module is a free alternative to services that usually require payment. The RSS protocol itself imposes limits, so posts can arrive late (new items are checked every 5~15 minutes).

Warning

The RSS protocol is inconsistent, partly because so many versions share the name (RSS 0.91, RSS 0.92, RSS 1.0, RSS 2.0, Atom 0.3, Atom 1.0). The reader runs checks to avoid duplicate posts caused by those differences. They work less well right after you add a feed and improve over time. A few feeds may still not work; that is usually not a bug on the bot's side, but if it happens, contact the developer on Discord (cycloptux#1543, or join the support server with this invite: https://gisl.eu/support) and we can look at it.

Managing RSS feeds

You add, edit, remove and list RSS feeds from your server's RSS page on this dashboard; there is no Discord command for it any more.

When you add a feed you pick the feed URL 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

The reader can scan an item's title and content for "bad words" or "crude language" before posting it.

The NSFW setting has 3 modes:

  • censor posts a NSFW URL wrapped in < > angle brackets, which stops Discord from auto-embedding it.
  • 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

This check is approximate. If the feed you plan to stream 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.

Keyword filtering

Adds a whitelist filter. If the item's title contains first word and/or (see below) second word, the item goes to the webhook; otherwise it is ignored. Enter a comma-separated list on the RSS 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.

  • AND will only allow items whose title contains all of the filtered words.
  • OR will allow items whose title contains 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 items whose title contains the filtered word(s).
  • Exclude will only allow items whose title does not contain the filtered word(s).

Combined with the filter match mode, this lets the reader include an item when at least one filter item matches (OR) or all do (AND), or exclude on the same logic: post when all items are absent from the item (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 items 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 with the value defined in the RSS feed.

Warning

Because RSS feeds vary, some or all of these values may be missing from an item. There are fallbacks, but check the feed yourself and build the header around what it provides.

Supported tags:

  • %feed_name%: the RSS feed name (fallback: the website URL, or the feed URL)
  • %author%: the name of the item's author (fallback: Unknown)
  • %title%: the title of the item (fallback: Unknown)
  • %content%: the item content ("description"), with an automated attempt to properly convert HTML formatting to markdown (fallback: None)
  • %content_clean%: the item content ("description") with all HTML tags stripped, so plain text (fallback: None)
  • %media_url%: the direct URL to the item's media content, if available (fallback: Empty String)
  • %categories%: the tags ("categories") assigned to an item, as a comma-separated list (fallback: None)
  • %timestamp% or %timestamp_utc%: the item creation time in UTC, with format YYYY-MM-DD HH:mm:ss (UTC).
  • %timestamp_iso%: the item creation time in UTC, as an ISO8601 string.
  • %timestamp_pst%: the item creation time in PST, with format YYYY-MM-DD HH:mm:ss (PST).
  • %url%: the item 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 item URL 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 item found in %feed_name%!

Custom webhook name

Sets a custom username on the webhook when new items are posted. Custom usernames take at most 32 characters.

Default: New items are posted by a webhook named after the feed

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 RSS 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 RSS page stops the stream and removes its link to the server webhook.

Listing feeds

The RSS page lists every RSS feed stream currently linked to a webhook in the server.