Workflows

How to Embed a Changelog in Your Website

Three ways to add a changelog to your site — widget, API, or iframe. Compare effort, control, and performance for each approach.

Why embed your changelog?

An embedded changelog keeps users informed without leaving your site. It increases feature adoption, reduces support tickets, and shows that your product is actively maintained.

Three ways to embed

1. JavaScript widget (recommended)

Drop a single script tag and get a beautiful, auto-updating changelog popup:

<!-- Deplyd Widget — just one script tag -->
<script
  src="https://deplyd.dev/widget.js"
  data-project="your-project-slug"
  defer
></script>

At just 1.8KB gzipped, the Deplyd widget is lighter than most favicons. It loads asynchronously and never blocks your page.

2. REST API

For full control over the UI, fetch entries from the API and render them yourself:

// Fetch latest entries via API
const res = await fetch('https://deplyd.dev/api/v1/entries?limit=5', {
  headers: { 'Authorization': 'Bearer dpl_your_key' }
});
const entries = await res.json();

// Render in your UI
entries.data.forEach(entry => {
  console.log(`${entry.title} — ${entry.type}`);
});

3. iframe embed

If you use a custom domain with Deplyd, you can embed your changelog page directly:

<iframe
  src="https://changelog.yourapp.com"
  width="100%"
  height="600"
  frameborder="0"
></iframe>

Method comparison

Method Effort Design control Performance
WidgetLowMediumBest (1.8KB)
APIMediumFullGood
iframeLowLowOK

Tips for a great embedded changelog

  1. Load the widget lazily to keep your initial page load fast.
  2. Match the theme to your site (light, dark, or auto).
  3. Cache API responses if you build a custom integration.
  4. Always link to the full changelog page for users who want the complete history.

Ship changelogs that get read

Try Deplyd free — 1.8KB widget, REST API, and email notifications included.

Start free now