Usage and admin help
What is Status embed?
Status embed can only be used on public pages.
Some page viewers may not know about your status page and visit your website, knowledge base, or support portal for information on your service availability. You can add a status embed to pages your page viewers may visit when they think service is affected by an incident or maintenance. The status embed gives visibility to your Statuspage and makes status information accessible to any page viewer.
When you enter a new incident or maintenance on your status page, the status embed updates in real-time to display the incident title and description. The embed does not appear on the page if there are no ongoing incidents or maintenance.
The status embed for maintenance is shown 24 hours prior to the maintenance occurring and during ongoing maintenance, until the page viewer closes the status embed flag.
If multiple incidents occur simultaneously, the status embed displays the incident with the highest severity and the number of other incidents/maintenances.
The status embed can be implemented in two ways, via a recommended embed or a build your own embed.
The recommended embed is a colored flag with status messages and updates. You can customize the location and color of the recommended embed to suit your web page.
Implement the embed by copy/pasting an autogenerated code into your web page. When you make a status update on your status page, the flag automatically displays the same information on your deployed pages. See our configuration article for instructions.
The build your own embed is a more customizable option for those who have more developer resources. Use the Status API to create this embed for more control over the embed’s appearance and functionality.
Was this helpful?