# 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="../introduction-and-use-case" %}
[introduction-and-use-case](https://docs.squidex.io/id-02-documentation/introduction-and-use-case)
{% 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="https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2Fzk3JTpRHf303pMLvtB0W%2F2023-01-10_01-41.png?alt=media&#x26;token=eb003602-59be-4a84-ac55-5212b8428e0d" 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="https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2FqH1ywq79S4AiWoBW9tkp%2F2023-01-04_15-32.png?alt=media&#x26;token=5dc983d9-1487-477c-93b8-59e1f51f1e32" 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="https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2FM3KLQKfQizZbOxmsKBxp%2F2023-01-10_01-17.png?alt=media&#x26;token=b89a6519-81d2-4aa2-84ed-078987a443ba" 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="https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2F2JBqy1vy9XEYAsjAk3up%2F2023-01-10_01-23.png?alt=media&#x26;token=b3414eff-d171-4105-89e0-f0875a26d0a7" 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="https://2730255609-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LrL94QfeasZ0wF6YAvB%2Fuploads%2FTHCkXqvrkoz8OZbR2F7y%2F2023-01-10_01-45.png?alt=media&#x26;token=9d949a76-cd73-4521-b1a6-4f2cb212742c" alt=""><figcaption><p>Setting notification profile</p></figcaption></figure></div>
