> For the complete documentation index, see [llms.txt](https://docs.platter.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platter.com/checkout/checkout-extensions/alert-banner.md).

# Alert Banner

## What is an Alert Banner?

**Alert Banners** are used to display important updates, promotions, shipping information, or any other message you want to highlight during checkout.&#x20;

<figure><img src="/files/3g4pFEjrhG1gw2zw2znL" alt=""><figcaption><p>Example of a Warning alert.</p></figcaption></figure>

***

## Types of Alert Banners

There are four types of Alerts:

1. Info Alert
2. Success Alert
3. Warning Alert
4. Critical Alert

{% tabs %}
{% tab title="Info Alert" %}

#### Suggestion:

Use this alert type to share helpful, non-urgent information that guides customers during the checkout process, such as shipping promotions or policies.

<figure><img src="/files/CXjY9ZcfWJ3mDNpHqYuP" alt=""><figcaption><p>Example of an Info alert.</p></figcaption></figure>
{% endtab %}

{% tab title="Success Alert" %}

#### Suggestion:

Use this alert type to confirm details such as eligibility for discounts or free shipping. Success alerts help reassure customers and build confidence at checkout.

<figure><img src="/files/zzGw6o3j4PRZvOckx0C9" alt=""><figcaption><p>Example of a Success alert.</p></figcaption></figure>
{% endtab %}

{% tab title="Warning Alert" %}

#### Suggestion:

Use this alert type to warn customers about potential issues or encourage them to act quickly, such as low stock or expiring offers. Warnings are a great way of driving urgency or creating scarcity.

<figure><img src="/files/KkBdM3OzbMfcTaVSsq0r" alt=""><figcaption><p>Example of a Warning alert.</p></figcaption></figure>
{% endtab %}

{% tab title="Critical Alert" %}

#### Suggestion:

Use this alert type to highlight urgent issues that require immediate customer action, such as completing their order. Critical alerts are a valuable way to prevent abandoned checkouts and decrease customer errors.

<figure><img src="/files/XIHKyLDc1bNMDpvM6uMP" alt=""><figcaption><p>Example of a Critical alert.</p></figcaption></figure>
{% endtab %}
{% endtabs %}

***

## Configuring Alert Banners

Follow the instructions below to setup an **Alert Banner:**

1. From the dashboard, go to **Extensions** tab.
2. In the Extensions page, scroll down and find the extension you'd like to set up and click **Add to Checkout.**
3. Open the **Settings** window, and adjust the content and styling of the Alert Banner.\
   ![](/files/3HKVs9tmydOJopG1Ar2o)
4. Enter a custom name (optional).\
   ![](/files/7D54shxWrqqMuE4GihhD)
5. Click the **`+`** icon to copy the Handle to your clipboard.\
   ![](/files/Bu8UB42qnBL8TSP9Svp1)
6. Hit **`Save`** to to ensure your settings and saved.
7. Open your Checkout Editor and [install your extension](/get-started/quick-start-guide.md#installing-an-extension).


---

# 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, and the optional `goal` query parameter:

```
GET https://docs.platter.com/checkout/checkout-extensions/alert-banner.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
