How to include a Status Page badge image?Badge URLInclude the badge in your HTMLCustomize the badge colors
Articles on: Automate
If you're using Crisp Status to run your status page, you may want to display a little colored badge image in your website footer, to show your current systems status. That's possible with Crisp Status.
A status badge image can be useful to have a quick overview of your systems status by looking at your main website footer, without even opening the actual status page.
The status badge image takes the color of the current status: either green for
healthy
, orange for
sick
and red for
dead
.
Here's how you can show a status badge on your website:
- Get your status page URL, eg.
https://acme.crisp.watch(can be a custom domain)
- Append
/includes/badge/to the page URL
- This gives
bcf35751-f1f1-4f76-aae7-8e4d3615f656
- Use this URL to include the status badge as an image
As an example, here's the valid URL of the status badge of a website using Crisp Status:
https://status.enrich.email/includes/badge/
You should include the status badge as an image in your HTML:
undefined 
Make sure to replace all example URLs with your actual badge URL, pointing to your status page domain.
If you want to change the colors used in the badge image, for each status, you can pass an hexadecimal color code for each health type, with the following query parameters:
- Healthy:
?healthy=000000(replace with your color code)
- Sick:
?sick=000000(replace with your color code)
- Dead:
?dead=000000(replace with your color code)
For example, to customize the
healthy
status color, you would use an URL such as:
undefined 
Please omit the leading '#' character when passing the hexadecimal code. Any invalid hexadecimal color code will be ignored.
Updated on: 13/06/2022
Updated on: 19/07/2024
Thank you!