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

# Get Started

## 🗂️ <mark style="color:blue;">Overview</mark>

Get started with the **iAlert - Low Stock Alert** app! Quickly notify merchants when their stock levels fall below a predefined threshold, designed for ease and efficient inventory management..

***

## 🗃️ <mark style="color:blue;">Introduction</mark>

The **iAlert – Low Stock Alert** app helps merchants stay informed when stock levels drop below a set threshold. Users can define a minimum stock value, and when inventory reaches or falls below this limit, a notification is automatically sent to the designated email. This ensures timely restocking, preventing inventory shortages from disrupting business operations.

***

## 📌 <mark style="color:blue;">How To Get Started?</mark>

This section guides you through the essential steps to efficiently send an e-mail notification alert, when the stock level of a product is low.

{% hint style="success" %}
All the images in this section can be enlarged by clicking on them
{% endhint %}

***

### **📑&#x20;**<mark style="color:blue;">**Step 1: Details And Filters**</mark>

***

{% stepper %}
{% step %}
Start by clicking the **Create Alert** button. This will take you to the **Details & Filters** section, where you can refine your alert settings.
{% endstep %}

{% step %}
Next, enter the required **Details** to customize your notifier according to your preferences.&#x20;

<figure><img src="/files/U1NlMUHt5nYRcrPMh1B1" alt=""><figcaption><p>Details &#x26; Filters</p></figcaption></figure>
{% endstep %}

{% step %}
To add a filter, click the **Add Filter** tab, choose one of the predefined options that best suit your preferences, and then click **Next**.

<figure><img src="/files/CUw99g6tWUEA4tdHmO2t" alt=""><figcaption><p>Add Filters</p></figcaption></figure>
{% endstep %}
{% endstepper %}

***

### **📄**<mark style="color:blue;">**Step 2: Rules And Frequency**</mark>

***

{% stepper %}
{% step %}
Define the **Stock Calculation Rule** by selecting inventory locations using **Select Locations** and specifying quantity types with **Select Quantity Types**, based on your store’s requirements.
{% endstep %}

{% step %}
In the next step, set the Minimum Stock Threshold using the **Stock Threshold Rule**, which determines when an alert will be triggered based on the stock levels and then click on **Next** to proceed.

<figure><img src="/files/xBcAw9l6Tug5OjJPv7yx" alt=""><figcaption><p>Rules Section</p></figcaption></figure>
{% endstep %}

{% step %}
After setting the rules, go to the **Frequency** section and choose how often you want to receive notifications—either **Scheduled** or **Instant**, based on your needs.

<figure><img src="/files/0dllaY0Wb192EGcCza5N" alt=""><figcaption><p>Frequency</p></figcaption></figure>
{% endstep %}
{% endstepper %}

{% hint style="success" %}
You can set different value for MIN\_STOCK\_THRESHOLD for different items
{% endhint %}

***

### **🗳️&#x20;**<mark style="color:blue;">**Step 3: Configure Notification Channels**</mark>

***

{% stepper %}
{% step %}
To receive an alert, enter the **E-mail** address where you’d like to get notifications in the predefined email template. Alternatively, you can link your **Slack** account to receive alerts directly on Slack.
{% endstep %}

{% step %}
Once you have entered all the details and configured the notification channels, click the **Save** button. The created notifier will now be visible on the Alerts section.

<figure><img src="/files/lxeyam1ahiUkWej93A7s" alt=""><figcaption><p>Notifications Channel</p></figcaption></figure>
{% endstep %}
{% endstepper %}