Status Badges
Monitor your last-build status using BrowserStack status badges.
You can monitor your last build’s status, from your project page, using BrowserStack status badges.
The badges will update in real-time to display the status of your latest build.
Build status and corresponding badges:
| Status Badge | Description |
|---|---|
| Latest build ran successfully | |
| Latest build has a session error | |
| Latest build has a session timeout | |
| A build is currently executing | |
| Project doesn’t have any builds | |
| Bad request. For example: invalid key |
Adding status badges to your project page
Badges can be added as markdown (to your README) or an HTML snippet (to your project site). Follow the steps below:
1. Pick a project
To add status badges to a project, you need to give it a project name. If you haven’t specified a project name for your builds / sessions, add the capability project: <project_name> in your test scripts.
Run the following command:
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" https://api.browserstack.com/automate/projects.json
If you don’t have project names specified for your builds / sessions, the command above will return a blank response.
2. Obtain badge key
Obtain the status badge key for your project.
Generating a badge key makes your project’s BrowserStack dashboard public.
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" https://api.browserstack.com/automate/projects/<project-id>/badge_key
3. Add snippet to your project site or README
Replace the <badge_key> with what you obtained in the previous step and add the following markdown to your project’s README.
[](https://automate.browserstack.com/public-build/<badge_key>)
OR you can add the following HTML snippet to your project site.
<a href="https://automate.browserstack.com/public-build/<badge_key>"><img src='https://automate.browserstack.com/badge.svg?badge_key=<badge_key>'/></a>
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!