> For the complete documentation index, see [llms.txt](https://docs.spike.sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spike.sh/status-pages/live-status-widget.md).

# Live status widget

<figure><img src="/files/0jbPjoOIMPaE1bec3RIK" alt="Live status widget embedded on a website"><figcaption></figcaption></figure>

The live status widget displays your system's current health directly on your website. Paste the code snippet into any page: footer, contact page, support docs, header dropdown, or sidebar.

## Status priority order

The widget shows the highest-priority status across all your components:

1. Planned Maintenance
2. Critical Outage
3. Partial Outage
4. Degraded Performance
5. Operational

For example, if components A, B, and C are in *Degraded Performance* and component D is in *Critical Outage*, the widget shows *Critical Outage*.

## Customisation

Spike supports Light, Dark, and System themes out of the box. You can override Spike's default CSS to modify the look and feel. All HTML classes use the **`spike--`** prefix.

### How to enable

1. Visit your status page dashboard at <https://statuspage.spike.sh>
2. Navigate to **Widget** from the sidebar
3. Enable **Embed Live Status Page Widget** <img src="/files/dVwdrk3RwKJYOaTAhmw7" alt="" data-size="line">
4. Click **Get code** and paste it in your `<body>` tag

You can initialise the widget with configuration options:

```javascript
<script>
    // Initialize the widget with custom settings
    Spike.initializeStatusWidget({
        element: "#spike-live-status", // set your html element's unique identifer
        statusPageId: "<your unique id>", // do not change this
        theme: "system", // Other options -> light, dark
        console: true // Set to 'false' to disable error logs
    })
</script>
```

{% hint style="info" %}
Adjust the loading and initialisation to fit your frontend stack.
{% endhint %}

{% tabs %}
{% tab title="Large rounded corners" %}

<figure><img src="/files/4np7EQkiJ5m4zgblXEVE" alt="Live status widget with large rounded corners"><figcaption></figcaption></figure>
{% endtab %}

{% tab title="Small rounded corners" %}

<figure><img src="/files/n2sZytI2BVq0orTJaHvZ" alt="Live status widget with small rounded corners"><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

## Security

Add your domains to the allowlist so the widget loads correctly. Use `*.example.com` to allow all subdomains. For local testing, add your testing domain (such as an [ngrok](https://ngrok.com) URL) to the allowlist temporarily.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.spike.sh/status-pages/live-status-widget.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
