Badges

Get a badge for your experiment to integrate the latest run state, e.g., in wikis, ticketing tools, or wherever else it is valuable for you. You can easily integrate the badge using HTML, Markdown, or just a hosted image.

We support two badges:

  • an experiment badge that shows the latest run state of a specific experiment

  • an incident badge that either creates an experiment linked to an external reference or shows the latest run as soon as it is created state

Experiment Badges

You can reference an experiment on any external web page using badges, like this one:

It’s an excellent way to get a link to your experiment and view the status without navigating and logging into the Steadybit platform.

Go to an experiment that interests you, and click on the experiment badge icon on the top right.

You can choose your badge's desirable format and scale and copy the resulting script.

Alternatively, below are examples to copy and adjust to create your badge manually

Example Markdown

example.md
Template:
[![{{expermiment-key}}](https://platform.steadybit.com/api/experiments/{{experiment-key}}/badge.svg?tenantKey={{tenant-key}})](https://platform.steadybit.com/experiments/{{team-key}}/edit/{{experiment-key}}/executions/?tenant={{tenant-key}}~)

Example:
[![SHOP-61](https://platform.steadybit.com/api/experiments/SHOP-61/badge.svg?tenantKey=demo)](https://platform.steadybit.com/experiments/SHOP/edit/SHOP-61/executions/?tenant=demo~)

Example HTML

example.html
Template: 
<a href="https://platform.steadybit.com/experiments/{{team-key}}/edit/{{experiment-key}}/executions/?tenant={{tenant-key}}~" rel="nofollow"><img alt="{{experiment-key}}" src="https://platform.steadybit.com/api/experiments/{{experiment-key}}/badge.svg?tenantKey={{tenant-key}}" style="max-width: 100%;"></a>

Example
<a href="https://platform.steadybit.com/experiments/SHOP/edit/SHOP-61/executions/?tenant=demo~" rel="nofollow"><img alt="SHOP-61" src="https://platform.steadybit.com/api/experiments/SHOP-61/badge.svg?tenantKey=demo" style="max-width: 100%;"></a>

Badges linked to external references

Experiment badges always link to an existing experiment. But what if you would like to have some external reference? Let's say you are writing documentation/postmortem for an INCIDENT-100 and want to link one or more experiments via a badge. Maybe even before you've actually created the experiments to replay the incident. This is where the second kind of badge comes into play.

You can create the incident badge at the Steadybit dashboard by clicking 'Create Incident Badge'.

Next you need to specify your external unique identifier (e.g. INCIDENT-100) and can choose the desirable format and scale of your badge.

Alternatively, below are examples to copy and adjust to create your badge manually

Markdown

example.md
Template:
[![{{external-reference}}](https://platform.steadybit.com/api/badges/linked-badge.svg?tenantKey=demo&externalReference={{external-reference}})](https://platform.steadybit.com/api/badges/link?tenantKey=demo&externalReference={{external-reference}})

Example:
[![INCIDENT-100](https://platform.steadybit.com/api/badges/linked-badge.svg?tenantKey=demo&externalReference=INCIDENT-100&createCaption=Create%20experiment%20for%20incident%20100)](https://platform.steadybit.com/api/badges/link?tenantKey=demo&externalReference=INCIDENT-100)

HTML

example.html
Template: 
<a href='https://platform.steadybit.com/api/badges/link?tenantKey=demo&externalReference={{external-reference}}' target='_blank'><img alt="{{external-reference}}" src='https://platform.steadybit.com/api/badges/linked-badge.svg?tenantKey=demo&externalReference={{external-reference}}'></a>

Example
<a href='https://platform.steadybit.com/api/badges/link?tenantKey=demo&externalReference=INCIDENT-100' target='_blank'><img alt="INCIDENT-100" src='https://platform.steadybit.com/api/badges/linked-badge.svg?tenantKey=demo&externalReference=INCIDENT-100&createCaption=Create%20experiment%20for%20incident%20100'></a>

Last updated