# Notifications

This documentation is based on the *FoodCrunch* use case. Please open the link below alongside this page to understand the examples.

{% content-ref url="/pages/-MSTfiNBwo8C1m-UB3WL" %}
[Introduction and Use Case](/id-02-documentation/introduction-and-use-case.md)
{% endcontent-ref %}

## Introduction

Squidex provides a notification service that is power by *Notifo*. [*Notifo*](https://notifo.io) is an open source general purpose notification framework, initially developed for Squidex to enable users to subscribe to changes and receive notifications.

### Scenarios Where Notifications Can Be Triggered

* When there is a content item change.
* When there are changes made to the schema.
* When there are changes to contributors, such as adding contributors or changing their roles.&#x20;
* Notifications can also be triggered by rules.
* Notifications are also triggered by mentions and comments, e.g. if you add "*@user*" to a comment

{% hint style="info" %}
This notification service only works in Squidex Cloud (i.e. cloud.squidex.io) by default. To use this service in a self-hosted installation, you must separately install and run the Notifo service. Click here for installation instructions (coming soon).&#x20;
{% endhint %}

### How Notifications Work

* Notifications can be received through email or (web) push notifications.

{% hint style="info" %}
At the time of writing this article, email notifications are not operational.
{% endhint %}

* Those subscribing to a change won't see any notifications if they initiated the changes themselves. A notification is only created if changes are made by someone else.

The notification icon is situated on the top menu bar, next to the user icon. Clicking on this displays *Notifications*, *Archive* (archived notifications) and the notification *Profile*.

<div align="left"><figure><img src="/files/WGfky7jSgso62YAfJXdV" alt=""><figcaption><p>Notification icon</p></figcaption></figure></div>

## Subscribing to Changes

Follow the instructions below to subscribe to changes. For this purpose of this example we are subscribing to changes in **Settings** > **Contributors**.

1. Navigate to **Settings** (1) and then **Contributors** (2) for your App.<br>

   <div align="left"><figure><img src="/files/EnLeDg0GA0ByPxofZEWK" alt=""><figcaption><p>Contributor settings for the app</p></figcaption></figure></div>
2. Next, subscribe to the changes. To do so, click on the **bell icon** (3) and then toggle to the **notification mediums of choice** (4), Notifications can be received by Email and/or Push Notifications. Next, click **Save** (5).<br>

   <div align="left"><figure><img src="/files/BrdUBXDAskEJuuOjP6Xh" alt=""><figcaption><p>Subscribing to notifications</p></figcaption></figure></div>
3. At this point a new contributor can be added or invited. To test notifications, you can add a contributor. \
   \
   To do so, **enter the name or email** (1) address of the contributor (a drop down menu appears making it easy to select an existing user or enter an email address if you wish to add a new user). Next, select the role for example **Editor** (2) and click **Add Contributor** (3). \
   \ <mark style="color:orange;">NOTE: Subscribers will only receive a notification if the change is actioned by another user.</mark><br>

   <figure><img src="/files/7CoaISLxNENvCUt1DFD5" alt=""><figcaption><p>Adding a contributor</p></figcaption></figure>
4. Whenever a new contributor is added, the subscribed user will receive a notification through their chosen notification methods (currently, only Web Push Notifications work). An example of a (eWb) Push Notification can be viewed below.

## Setting the Notification Profile

To set the notification profile, click the **Notification icon** (1) on the top bar and then select the **Profile** tab (2). You can set your notification preferences, notification email and preferred time zone amongst other settings.

<div align="left"><figure><img src="/files/qXXjzZnSbHBemmHYziCZ" alt=""><figcaption><p>Setting notification profile</p></figcaption></figure></div>


---

# Agent Instructions: 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.squidex.io/id-02-documentation/concepts/notifications.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.
