# notifications

**Repository Path**: mirrors_nextcloud/notifications

## Basic Information

- **Project Name**: notifications
- **Description**: 🔔 Notifications app for Nextcloud
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-08
- **Last Updated**: 2026-01-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
  - SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
  - SPDX-FileCopyrightText: 2015-2016 ownCloud, Inc.
  - SPDX-License-Identifier: AGPL-3.0-only
-->
# Notifications

[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/notifications)](https://api.reuse.software/info/github.com/nextcloud/notifications)

This app provides a backend and frontend for the notification API available in [Nextcloud](https://github.com/nextcloud/server/).
The API is used by other apps to notify users in the web UI and sync clients about various things. Some examples are:

* 📬 [Federated file sharing](https://github.com/nextcloud/server/tree/master/apps/federatedfilesharing): You received a new remote share
* 📑 [Comments](https://github.com/nextcloud/server/tree/master/apps/comments): Another user mentioned you in a comment on a file
* 🚢 [Update notification](https://github.com/nextcloud/server/tree/master/apps/updatenotification): Available update for an app or nextcloud itself
* 📣 [Announcement center](https://github.com/nextcloud/announcementcenter): An announcement was posted by an admin

## Screenshot

![Screenshot of the notification icon and dropdown](https://raw.githubusercontent.com/nextcloud/notifications/master/docs/screenshot.png)


## Developers

### Install and enable the notifications app

- Clone this app into the "apps" folder of your nextcloud instance.
```bash
git clone https://github.com/nextcloud/notifications.git
```

- Enable the app (Log in as the admin into your nextcloud, go to "+ Apps" and search for the "notifications" app to
 enable it).

- When you modified the code make sure to execute `make dev-setup` from within the app´s root folder to install develop dependencies and afterwards build the javascript with `make build-js-production`.
 
### Creating notifications for your app

For information how to make your app interact with the notifications app, see
[Sending and processing/"mark as read" notifications as a Nextcloud App](https://github.com/nextcloud/notifications/blob/master/docs/notification-workflow.md)
in the wiki.

If you want to present notifications as a client, see [Reading and deleting notifications as an Nextcloud Client](https://github.com/nextcloud/notifications/blob/master/docs/ocs-endpoint-v1.md).