Public Release Notes API
Read your published release notes and FAQs as JSON or RSS, and show them anywhere. No API key required.
How It Works
No API Key Needed
These endpoints only return content you have already published, so they need no authentication. They allow requests from any origin (CORS), so you can call them from the browser.
GET https://www.engammo.com/api/widget/wgt_abc123/notesResponse Format
JSON endpoints return the requested items plus pagination fields: total, page, limit and totalPages. The notes endpoint also returns the language and the available languages.
{ "notes": [...], "total": 47, "page": 1, "limit": 10, "totalPages": 5 }Widget IDs
Create a widget for a repository in the Engammo dashboard to get its ID. The same ID powers the embeddable script and the JSON endpoints.
<script src="https://www.engammo.com/widget.js" data-widget-id="wgt_abc123"></script>RSS
Every public updates page has an RSS feed. Internal pages do not expose a feed.
https://www.engammo.com/api/updates/{projectId}/feed.xmlEndpoints Overview
All endpoints are read-only and relative tohttps://www.engammo.com.
/api/widget/{widgetId}/notesReturns published release notes for a widget, newest first. Query parameters: page, limit (max 50), tags (comma-separated) and lang (en, it or es).
Use case: Render release notes in your own changelog page, app or internal dashboard.
/api/widget/{widgetId}/faqsReturns the FAQs generated from your release notes. Query parameters: page, limit (max 50), tags, q (search) and lang.
Use case: Show product FAQs next to your docs or support content.
/api/updates/{projectId}/feed.xmlAn RSS 2.0 feed of the entries on a public updates page.
Use case: Let customers subscribe to your changelog in any feed reader, or pipe updates into other tools.
Example Use Cases
Custom Changelog Page
Fetch published notes from the widget endpoint and render them with your own design on your website or documentation site.
In-App "What's New" Panel
Embed the Engammo widget with one script tag, or call the JSON endpoint and build your own panel in React or any other framework.
Internal Dashboards
Pull release notes as JSON into the dashboards your team already uses to track what shipped.
Feed Readers and Automation
Subscribe to the RSS feed, or connect it to any tool that can read RSS to forward updates elsewhere.
Related Resources
Frequently Asked Questions
Is there an API to generate or edit release notes?
Not yet. Release notes are generated automatically from GitHub and managed in the Engammo dashboard. The public endpoints on this page are read-only.
Do I need an API key?
No. The public endpoints only expose content you have published, so no key is needed. Hide a note in the dashboard to remove it from the widget and feeds.
Are there rate limits?
Public endpoints are intended for displaying your release notes. Cache responses where you can, and contact us if you expect high traffic.
Which languages can I request?
Pass lang=en, lang=it or lang=es. Translations are available on Team and Enterprise plans for the languages you enable.
Where can I find full integration details?
Our integration guide at engammo.com/SKILL.md covers widget configuration, response formats and code examples in JavaScript and React.
Show your release notes anywhere
Connect GitHub, publish release notes automatically, and embed them with one script tag or a JSON request.