DOCS

Embed a status widget

Embed a compact status badge or iframe widget on your website, dashboard, or README to surface real-time uptime.

Embed a compact status badge or widget directly on your website, dashboard, or README to surface your status page's real-time uptime.

Embed types

  • Status badge — an SVG badge showing the current status (Operational / Degraded / Down).
  • Iframe widget — a mini status page embedded in an iframe.

Get the embed code

  1. Go to Status Pages → [Your Page] → Embed.
  2. Choose an embed type: badge or iframe.
  3. Copy the generated HTML snippet.
  4. Paste it into your website's HTML.

SVG badge

<img src="https://api.howlops.com/api/v1/public/status-pages/your-slug/badge.svg" alt="Status" />

For a Markdown file (such as a GitHub README):

![Status](https://api.howlops.com/api/v1/public/status-pages/your-slug/badge.svg)

Iframe widget

<iframe
  src="https://howlops.com/status-page/your-slug/embed"
  width="100%" height="200"
  frameborder="0">
</iframe>

FAQ

Does the badge work on GitHub READMEs? Yes. The SVG badge renders in README.md files on GitHub and GitLab.

Can I style the widget? The iframe widget inherits your status page branding. The badge color changes to green / yellow / red based on status.

Does it work on password-protected pages? The embed inherits the page's protection, so a password-protected page will not render in a public embed.

Was this page helpful?