Skip to content

All developer docs

RSS and JSON Feed for your changelog

Every Changeloop changelog is also a feed readers can subscribe to, in RSS 2.0 and JSON Feed 1.1, and a single markdown document. This page covers the endpoints, the filters they share with the JSON feed, and what each format carries.

RSS and JSON Feed

GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/rss.xml
GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/feed.json

The same published entries as a subscribable feed, in the two formats readers understand: RSS 2.0 and JSON Feed 1.1. Both take the same repos, category and tag filters as the changelog feed and carry the same Cache-Control and ETag. Neither pages: a reader polls the head of the feed, so these return the most recent entries only, with no cursor.

Entry text is the sanitised HTML, wrapped in CDATA for RSS and as content_html for JSON Feed, with your images in it once you have turned images on. An entry's header image is a media:content element in RSS and the item's image in JSON Feed. JSON Feed additionally carries your tag colours under a namespaced _changelogapp extension; RSS does not, because no reader would paint them.

The hosted page advertises both as rel="alternate" links, so a browser or reader that lands on it can subscribe without being told the paths.

The markdown feed

GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/changelog.md

The same published entries as plain markdown, served as text/markdown. It exists for readers that are not browsers: an LLM or an agent answering "what changed recently in this product" gets the text without parsing RSS or walking JSON. It takes the same repos, category and tag filters as the changelog feed, carries the same Cache-Control and ETag, and answers 304 to a conditional request exactly like the other two.

Each entry is a section: the title as a heading, then a single line carrying the date, the category and any tags, then the header image as a markdown image line if the entry has one from a host on your list, then the entry text, then the Learn more link if the entry has one, then its permalink. The document opens with your feed title and description and links back to the hosted page. When nothing is published yet it says so in a sentence rather than returning an empty body, so a reader can tell that apart from a failed fetch.

The sitemap

GET https://api.changeloop.dev/v1/public/YOUR_PUBLIC_ID/sitemap.xml

A sitemap of one changelog, for search engines: the changelog page and the permalink of every published entry, at the addresses your readers see, which are on your own domain once you have set one under Settings, Custom domain. An entry's lastmod is the date it was published, and the page's is the date of your newest entry. It lists the newest 1000 entries, takes no filters, and carries the same Cache-Control and ETag as the feeds, so it answers 304 to a conditional request.

A search engine will not find this file on its own, and it accepts a sitemap only for pages on the host that serves the file, or when the file is submitted for that site. So submit this address in your search console, for the domain your changelog is on.

The changelog feed

Your published entries, newest first, with the newest id breaking ties on identical timestamps.

A changelog people can subscribe to

Changeloop drafts each entry from a merged pull request, holds it for your review, and publishes it to the JSON feed, RSS, JSON Feed and markdown at once. Free for one repository, no card.

Start free

Read the developer docs