Use status badges to monitor BrowserStack App Automate projects

Status badges to monitor your project status. Add markdown or html snippet to see the result of the latest build run in your BrowserStack App Automate project.

BrowserStack status badges

You can monitor your last build’s status from your project page using BrowserStack App Automate status badges.

Build status and corresponding badges:

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 to list your projects :

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/projects.json"

2. Obtain badge key

Obtain the status badge key for your project.

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-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.

[![BrowserStack Status](https://app-automate.browserstack.com/badge.svg?badge_key=<badge_key>)](https://app-automate.browserstack.com/public-build/<badge_key>?redirect=true)

OR you can add the following HTML snippet to your project site.

<a href="https://app-automate.browserstack.com/public-build/<badge_key>?redirect=true"><img src='https://app-automate.browserstack.com/badge.svg?badge_key=<badge_key>'/></a>