In-App Widget Installation

Available on Solo and Team plans.

The ShipRelay widget adds a "What's New" button to your web application. When clicked, it opens a popup showing your latest 5 releases.

Installation

Add this script tag to your HTML, just before the closing </body> tag:

html

<script
  async
  defer
  src="https://shiprelay.io/widget.js"
  data-shiprelay-api-key="YOUR_API_KEY"
  data-shiprelay-position="bottom-right"
></script>

Replace YOUR_API_KEY with your project's API key. Find it in your dashboard under Settings → Widget Installation.

That's it. No build step, no npm install, no framework dependency.

Configuration options

Attribute	Values	Default	Description
`data-shiprelay-api-key`	Your API key	(required)	Identifies your project
`data-shiprelay-position`	`bottom-right`, `bottom-left`	`bottom-right`	Widget button position

What the widget shows

A floating button with an unread badge (count of releases the visitor hasn't seen)
On click: a popup listing the latest 5 releases with version, date, and summary
Each entry links to the full release on your hosted changelog page

Technical details

Under 15KB gzipped
Loads asynchronously — will not slow down your page
Works without cookies — uses localStorage for read/unread state
Privacy-safe: tracks anonymous impressions only (no PII collected)
If the API key is invalid or missing, the widget renders nothing — no console errors on your page

Analytics

Widget impressions and clicks are tracked on your ShipRelay analytics dashboard.

API key security

Your API key is project-scoped (one per repository). If you suspect abuse, regenerate it from the dashboard under Settings → Widget Installation. The old key stops working immediately.

Tip

Add the widget to your staging environment first to verify positioning and styling before deploying to production.

Email Digest

RSS Feed