Status badges

Status badges are visual representations of your site’s status, served as image files you can add to repository READMEs, documentation, or any other web page.

The deploy status badge automatically updates to show the status of a site’s most recent production or branch deploy:

badges indicating deployment statuses: success, building, canceled, or failed.

# Add status badges

To find the specific image URL for your site, go to your Site settings > General > Status badges. For markdown files like repository READMEs, we include a markdown snippet you can copy and paste directly, complete with a link to your site’s Deploys page when the badge is selected.

To create a status badge for a deployed branch, add the ?branch= query parameter to the badge image URL. For example, if the branch name is dev, the image URL should end with /deploy-status?branch=dev.