-
Notifications
You must be signed in to change notification settings - Fork 230
Add guide: RSS email campaigns #5154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
mintlify
wants to merge
2
commits into
main
Choose a base branch
from
mintlify/rss-email-guide-1775493589
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+131
−0
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| --- | ||
| title: "Set up email notifications from your changelog RSS feed" | ||
| sidebarTitle: "RSS email campaigns" | ||
| description: "Send automatic email notifications to subscribers when you publish changelog updates using your RSS feed with Zapier, Make, or other automation tools." | ||
| keywords: ["RSS", "email", "changelog", "Zapier", "Make", "notifications", "campaign"] | ||
| --- | ||
|
|
||
| Mintlify generates an [RSS feed](/create/changelogs#subscribable-changelogs) for any page that uses `Update` components. You can connect this feed to an automation tool like Zapier or Make to send email notifications whenever you publish a new changelog entry. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A Mintlify changelog page with `Update` components | ||
| - A [Zapier](https://zapier.com) or [Make](https://www.make.com) account (free tiers available) | ||
| - An email service or mailing list (Mailchimp, SendGrid, or the built-in email options in Zapier/Make) | ||
|
|
||
| ## Find your RSS feed URL | ||
|
|
||
| Your RSS feed URL is your changelog page URL with `/rss.xml` appended. For example, if your changelog is at `https://docs.example.com/changelog`, your RSS feed is at: | ||
|
|
||
| ```text | ||
| https://docs.example.com/changelog/rss.xml | ||
| ``` | ||
|
|
||
| To verify, open the URL in your browser. You should see an XML document with your changelog entries. | ||
|
|
||
| <Tip> | ||
| Add `rss: true` to your changelog page frontmatter to display an RSS icon button that links to the feed. See [subscribable changelogs](/create/changelogs#subscribable-changelogs) for details. | ||
| </Tip> | ||
|
|
||
| ## Set up email notifications | ||
|
|
||
| <Tabs> | ||
| <Tab title="Zapier"> | ||
|
|
||
| Use Zapier to connect your RSS feed to an email action. | ||
|
|
||
| <Steps> | ||
| <Step title="Create a new Zap"> | ||
| 1. Log in to [Zapier](https://zapier.com) and click **Create**. | ||
| 2. Select **Zaps** to start a new automation. | ||
| </Step> | ||
| <Step title="Set up the RSS trigger"> | ||
| 1. Search for **RSS by Zapier** as your trigger app. | ||
| 2. Select **New Item in Feed** as the trigger event. | ||
| 3. Paste your RSS feed URL (for example, `https://docs.example.com/changelog/rss.xml`) into the **Feed URL** field. | ||
| 4. Click **Test trigger** to confirm Zapier can read your feed. | ||
| </Step> | ||
| <Step title="Set up the email action"> | ||
| Choose one of these options: | ||
|
|
||
| **Option A: Send a simple email notification** | ||
| 1. Search for **Email by Zapier** as your action app. | ||
| 2. Select **Send Outbound Email** as the action event. | ||
| 3. Fill in the email fields: | ||
| - **To**: The recipient email address (or a distribution list) | ||
| - **Subject**: Use the RSS item title from the trigger data, for example: `New update: {{title}}` | ||
| - **Body**: Use the RSS item description or link, for example: `We just published a new update. Read it here: {{link}}` | ||
|
|
||
| {/* TODO: Verify this Mailchimp flow in Zapier. "Send Campaign" may not be the right action event — Zapier's Mailchimp integration more commonly uses "Add/Update Subscriber". Consider replacing this option with a more reliable step or removing it entirely. */} | ||
| **Option B: Send to a mailing list (Mailchimp)** | ||
| 1. Search for **Mailchimp** as your action app. | ||
| 2. Select **Send Campaign** as the action event. | ||
| 3. Connect your Mailchimp account and select your audience. | ||
| 4. Map the RSS item title and link to your email template fields. | ||
| </Step> | ||
| <Step title="Turn on the Zap"> | ||
| Click **Publish** to activate your Zap. Zapier checks your RSS feed periodically and sends an email whenever a new entry appears. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| </Tab> | ||
| <Tab title="Make"> | ||
|
|
||
| Use Make to connect your RSS feed to an email action with a visual workflow builder. | ||
|
|
||
| <Steps> | ||
| <Step title="Create a new scenario"> | ||
| 1. Log in to [Make](https://www.make.com) and click **Create a new scenario**. | ||
| </Step> | ||
| <Step title="Add the RSS module"> | ||
| 1. Click the **+** button to add a module. | ||
| 2. Search for **RSS** and select **Watch RSS feed items**. | ||
| 3. Paste your RSS feed URL into the **URL** field. | ||
| 4. Set the **Maximum number of items** to a reasonable limit such as `5`. | ||
| 5. Click **OK** and then **Run once** to test the connection. | ||
| </Step> | ||
| <Step title="Add the email module"> | ||
| 1. Click the **+** button after the RSS module. | ||
| 2. Search for your email service: | ||
| - **Email**: Use the built-in **Send an email** module for simple notifications. | ||
| - **Mailchimp**, **SendGrid**, or **Brevo**: Use the respective module for mailing list campaigns. | ||
| 3. Connect your email account. | ||
| 4. Map the RSS fields to the email fields: | ||
| - **Subject**: Map the item `title` | ||
| - **Content**: Map the item `description` or `link` | ||
| </Step> | ||
| <Step title="Activate the scenario"> | ||
| 1. Set the schedule (for example, every 15 minutes). | ||
| 2. Toggle the scenario to **On**. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Test your setup | ||
|
|
||
| 1. Add a new `Update` component to your changelog page and deploy the change. | ||
| 2. Wait for the automation tool to check your feed (or trigger a manual run). | ||
| 3. Confirm the email arrives with the correct content. | ||
|
|
||
| {/* TODO: The `rss` prop takes an object `{ title, description }`, not just plain text. Consider updating this note to show the shape or link to /components/update for full prop details. */} | ||
| <Note> | ||
| RSS feed entries contain pure Markdown only. Components, code blocks, and HTML elements are excluded. Use the `rss` property on your `Update` components to provide alternative text for subscribers. See [subscribable changelogs](/create/changelogs#subscribable-changelogs) for details. | ||
| </Note> | ||
|
|
||
| ## Alternative tools | ||
|
|
||
| Other automation platforms that support RSS-to-email workflows: | ||
|
|
||
| | Tool | Description | | ||
| |------|-------------| | ||
| | [IFTTT](https://ifttt.com) | Simple RSS-to-email applets with a free tier | | ||
| | [Mailchimp RSS campaigns](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) | Native RSS-to-email feature within Mailchimp | | ||
| | [n8n](https://n8n.io) | Self-hosted or cloud automation with RSS and email nodes | | ||
| | [Buttondown](https://buttondown.com) | Newsletter tool with built-in RSS feed import | | ||
|
|
||
| The setup process is similar across all tools: point the tool at your RSS feed URL and configure an email action for each new item. | ||
|
|
||
| {/* TODO: Manually test all external links in the Alternative Tools table before publishing: IFTTT, Mailchimp RSS campaigns URL, n8n, Buttondown. */} | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO comments indicate unfinished content shipped to production
Low Severity
Three
{/* TODO */}comments remain in the file (lines 59, 112, and 130), indicating unresolved tasks: unverified Mailchimp steps, an inaccurate description of therssprop shape (it takes an object{ title, description }, not plain text), and untested external links. While hidden from readers via MDX comments, they represent unfinished verification work that ideally gets resolved before merging.Additional Locations (1)
guides/rss-email-campaigns.mdx#L111-L112Reviewed by Cursor Bugbot for commit ee98116. Configure here.