Embeddable Status Banner
The embeddable status banner gives you a slim, hosted status strip you can place on login pages, dashboards, help centers, and customer portals.
It is designed for cases where you want a clear status notice without embedding a full widget card.
What the Banner Does
The banner is controlled from your status page settings and rendered with a single script tag.
You can use it to:
- Always show a live status banner
- Show the banner only when there is an active incident
- Show the banner only during active or upcoming maintenance
- Show the banner when incidents or maintenance exist
- Show the banner only when your overall status is not operational
- Override the live message with a manual notice when needed
If you need a larger embedded card with incidents and charts, use the live widget instead.
Where to Configure It
You can configure the banner from either place:
- Go to Status Pages > Embeds / Widgets and open Embeddable Banner
- Or go to Status Pages > Your Page > Settings > Banner
Banner settings are saved per status page.
For the full settings layout, see Status Page Settings Guide.
Basic Embed Snippet
Add this where you want the banner to appear:
<script
src="https://statuspage.me/static/embed/v1/banner.min.js"
data-slug="your-slug"
data-theme="auto"
data-refresh="60000"></script>
Replace your-slug with your actual status page slug.
Script Options
| Option | Values | Description |
|---|---|---|
data-slug | your-slug | Your status page slug (required) |
data-theme | auto, light, dark | Runtime theme override |
data-refresh | milliseconds | Auto-refresh interval, minimum 10000 |
data-disable-link | 0 or 1 | Disable the “View status” link |
Most banner behavior is configured in your dashboard, not in the script tag.
Visibility Modes
Choose one of these visibility modes in the dashboard:
| Mode | Behavior |
|---|---|
| Always show | Banner is always rendered when enabled |
| Only when incidents exist | Banner appears only while active incidents exist |
| Only for maintenance | Banner appears for active maintenance and upcoming maintenance |
| Incidents or maintenance | Banner appears when either condition is true |
| Only when non-operational | Banner appears when the overall page status is not operational |
Upcoming maintenance currently means maintenance scheduled to begin within the next 24 hours.
For help creating incidents and maintenances that feed the banner, see Creating Incidents and Scheduling Maintenance.
Manual Override
Enable Use manual override message when you want the banner to display a custom notice instead of the automatic live message.
- Manual label is optional
- Manual message is required when manual override is enabled
Use manual override when you want to publish a short announcement such as:
- “We are investigating elevated latency.”
- “Planned maintenance starts at 22:00 UTC.”
- “Login performance may be delayed for some users.”
Appearance Options
You can control these display settings:
- Theme: auto, light, or dark
- Status dot: show or hide the colored status indicator
- Icon: show or hide the icon
- View status CTA: show or hide the link to your full status page
- Compact: use a tighter one-line layout
These settings are saved with the status page, so the same banner behavior is reused everywhere you embed it.
Good Places to Use It
- Login pages
- App dashboards
- Customer portals
- Support centers
- Internal admin tools
- Hosted documentation sites
Use the banner when you want status visibility near the user journey, especially before sign-in or inside product navigation.
Plan Availability
Embeddable banners are available on eligible paid plans.
If you do not see the feature enabled, check your current plan from Billing.
Troubleshooting
Banner does not appear
- Make sure the status page slug is correct
- Confirm the banner is enabled in your dashboard
- Check whether your selected visibility mode currently hides the banner
- Verify your plan includes banner embeds
- Check your browser console for script loading or CSP errors
Banner shows no message
- If manual override is enabled, make sure Manual message is filled in
- If you are using an automatic mode, check whether there are active incidents or maintenance events that match the selected mode
Banner links to the wrong place
- Review your status page URL and custom domain settings in Status Page Settings Guide
FAQ
Can visitors dismiss the banner?
Not in the current version. The banner is a hosted status notice and does not include a dismiss control.
Are banner settings shared across all status pages?
No. Banner settings are saved per status page.
Can I customize the text from the script tag?
No. Runtime script options only control embed behavior such as theme, refresh interval, and link visibility. The content itself is controlled from your dashboard.
What’s Next?
- Use the live widget for a richer embedded card
- Build custom integrations if you want to render your own UI
- Use the SVG badge for README files and compact status links
- Review status page settings for the full page configuration guide