PHPackages                             auroraextensions/notificationservice - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail &amp; Notifications](/categories/mail)
4. /
5. auroraextensions/notificationservice

ActiveMagento2-module[Mail &amp; Notifications](/categories/mail)

auroraextensions/notificationservice
====================================

Publish backend notifications via XML.

1.0.0(6y ago)03MITPHPPHP &gt;=7.1

Since Feb 4Pushed 6y ago1 watchersCompare

[ Source](https://github.com/auroraextensions/notificationservice)[ Packagist](https://packagist.org/packages/auroraextensions/notificationservice)[ RSS](/packages/auroraextensions-notificationservice/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (3)Versions (2)Used By (0)

- [Description](#description)
- [Installation](#installation)
- [Configuration](#configuration)
- [Examples](#examples)
- [XML Schema](#xml-schema)
    - [&lt;releases&gt;](#releases)
    - [&lt;release&gt;](#release)
    - [&lt;notifications&gt;](#notifications)
    - [&lt;notification&gt;](#notification)
    - [&lt;title&gt;,&lt;description&gt;](#title-description)
    - [&lt;link&gt;](#link)
- [Footnotes](#footnotes)

[Description](#id2)
-------------------

[](#description)

Magento provides a backend notification system that lacks powerful features, like auto-publish and discovery. Consequently, many extension vendors don't effectively utilize it for important announcements, like API-breaking releases, EOL notices, or deprecation of specific extension features, which can lead to transparency issues.

To address this issue, wouldn't it be nice if you could just add, say, an XML file to your module, which contains the notifications you want to publish, and the rest is handled by the notification system? It would remove the need for notification-specific models and data patches, and would not require setup upgrade to run in order for new notifications to publish.

*Bottom line*: It should be dead simple to use.

[Installation](#id3)
--------------------

[](#installation)

```
composer require auroraextensions/notificationservice
```

[Configuration](#id4)
---------------------

[](#configuration)

Configuration is as simple as adding a `notifications.xml` file to the module `etc` directory.

[Examples](#id5)
----------------

[](#examples)

Below is an example `notifications.xml`. For information on schema, see [XML Schema](#xml-schema).

```

                    v1.0.0 low-priority notification title
                    This is a low-priority notification about v1.0.0.

                    v1.0.0 high-priority notification title
                    This is a high-priority notification about v1.0.0.
                    https://www.example.com/

                    v1.0.1 medium-priority notification title
                    This is a medium-priority notification about v1.0.1.

```

[XML Schema](#id6)
------------------

[](#xml-schema)

To keep it simple, the XSD provides a minimal set of element and attribute types.

As with many Magento XML configurations, `` is the root node. All other nodes are descendants of ``.

### [&lt;releases&gt;](#id7)

[](#releases)

The `` node is the outermost node and has one (1) attribute, `group`. The value of the `group` attribute should be universally unique to prevent unwanted merging. It is an `array`-type and should contain only `` nodes.

Element``Parent``XPath`/config/releases`Attributesgroup:`string` (Required)RequiredYes### [&lt;release&gt;](#id8)

[](#release)

The `` node has one (1) attribute, `version`. The value of the `version`attribute should be the module version associated with the specific notification(s). It should contain only one (1) `` node.

Element``Parent``XPath`/config/releases/release`Attributesversion:`string` (Required)RequiredYes### [&lt;notifications&gt;](#id9)

[](#notifications)

The `` node is an `array`-type node and should only contain ``nodes. It has no associated attributes.

Element``Parent``XPath`/config/releases/release/notifications`AttributesNoneRequiredYes### [&lt;notification&gt;](#id10)

[](#notification)

The `` node describes the various components of a specific notification and has two (2) attributes, `index` and `severity`. The value of the `index` attribute must be an `int`, which denotes the notification position in the resulting array of notifications. The value of the `severity` attribute maps to levels defined in `MessageInterface` [\[1\]](#ref1), and must be one of the following:

- `critical`
- `major`
- `minor`
- `notice`

It should contain only one (1) node per each of the following types:

- ``
- ``
- `` (Optional)

Element``Parent``XPath`/config/releases/release/notifications/notification`Attributesindex:`int` (Required)severity:`string` (Required)RequiredYes### [&lt;title&gt;,&lt;description&gt;](#id11)

[](#titledescription)

The `` and `` nodes comprise the corpus of the notification. The ``node contains the text to display on the first line of the notification, and the ``node contains the body of the notification. Both nodes provide one (1) attribute, `translate`. The value of the `translate` attribute should always be `true`, otherwise simply omit the attribute to prevent translation.

Element``, ``Parent``XPath`/config/releases/release/notifications/notification/*[self::title or self::description]`Attributestranslate:`bool` (Optional)RequiredYes### [&lt;link&gt;](#id12)

[](#link)

The `` node contains a URL for the *Read Details* link. This node is optional and can be omitted. It has no associated attributes.

Element``Parent``XPath`/config/releases/release/notifications/notification/link`AttributesNoneRequiredNo[Footnotes](#id13)
------------------

[](#footnotes)

[\[1\]](#id1)[Magento\\Framework\\Notification\\MessageInterface](https://github.com/magento/magento2/blob/2.3/lib/internal/Magento/Framework/Notification/MessageInterface.php)

###  Health Score

22

—

LowBetter than 23% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2285d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/270c3d6fe70cec0479131d41d37fa4980679363605856166dc202cc44fe83740?d=identicon)[auroraextensions](/maintainers/auroraextensions)

---

Top Contributors

[![nickolasburr](https://avatars.githubusercontent.com/u/4663695?v=4)](https://github.com/nickolasburr "nickolasburr (126 commits)")

---

Tags

magentomagento2notificationsxml

### Embed Badge

![Health badge](/badges/auroraextensions-notificationservice/health.svg)

```
[![Health](https://phpackages.com/badges/auroraextensions-notificationservice/health.svg)](https://phpackages.com/packages/auroraextensions-notificationservice)
```

###  Alternatives

[magepal/magento2-gmailsmtpapp

Magento 2 SMTP Extension - Configure Magento 2 to send all transactional email using Gmail, G Suite, Amazon SES, Office360, Mailgun, SendGrid, Mandrill or any other SMTP servers

3321.8M2](/packages/magepal-magento2-gmailsmtpapp)[dotdigital/dotdigital-magento2-extension

Dotdigital for Magento 2

50374.2k18](/packages/dotdigital-dotdigital-magento2-extension)[mailchimp/mc-magento2

Connect MailChimp with Magento

1611.8M3](/packages/mailchimp-mc-magento2)[yireo/magento2-emailtester2

Preview transactional emails and test send them in your backend

33394.9k](/packages/yireo-magento2-emailtester2)[magepal/magento2-edit-order-email

Magento 2 edit order email

34288.1k](/packages/magepal-magento2-edit-order-email)[fooman/emailattachments-implementation-m2

Automatically attach pdf and terms and conditions documents to outgoing sales emails.

14880.1k3](/packages/fooman-emailattachments-implementation-m2)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
