MagicMirror² DocsMagicMirror² Docs
Donate
Discord
Forum
GitHub
Donate
Discord
Forum
GitHub
  • Getting Started

    • Introduction
    • Requirements
    • Installation & Usage
    • Upgrade Guide
  • Configuration

    • Introduction
    • Autostart your MagicMirror²
    • Raspberry Specific
  • Modules

    • Introduction
    • Module Configuration
    • Default Modules

      • Alert
      • Calendar
      • Clock
      • Compliments
      • Hello World
      • News Feed
      • Update Notification
      • Weather Module
    • Animation Guide
  • Module Development

    • Introduction
    • The Core module file
    • The Node Helper
    • MagicMirror Helper Methods
    • Logger
    • Notifications
    • Weather Module Weather Provider Development
    • How to write good documentation
  • About

    • MagicMirror² Manifesto
    • Contributing Guidelines
    • Donate
    • Support
    • License

Introduction

The MagicMirror core has the ability to send notifications to modules. Or even better: the modules have the possibility to send notifications to other modules.

Additional technical information on the notifications can be found in the modules' documentation:

  • notificationReceived
  • sendNotification

System notifications

The system sends three notifications when starting up:

NotificationPayloadDescription
ALL_MODULES_STARTEDnoneAll modules are started. You can now send notifications to other modules.
DOM_OBJECTS_CREATEDnoneAll dom objects are created. The system is now ready to perform visual changes.
MODULE_DOM_CREATEDnoneThis module's dom has been fully loaded. You can now access your module's dom objects.
MODULE_DOM_UPDATEDnoneThis module's dom has been updated and re-rendered. You can now access your module's (updated) dom objects. This notification is sent in response to a call to updateDom.

Default module notifications

These notifications are sent by the default modules:

NotificationPayloadDescription
SHOW_ALERTmessage detailsSent to alert module to show an alert or notification.
HIDE_ALERTnoneSent to alert module to hide the current alert or notification.
CALENDAR_EVENTScalendar eventsSent by calendar module to inform modules of the calendar events.
ARTICLE_NEXTnoneShows the next news title in newsfeed module.
ARTICLE_PREVIOUSnoneShows the previous news title in newsfeed module.
ARTICLE_MORE_DETAILSnoneShows more details in newsfeed module.
ARTICLE_LESS_DETAILSnoneHides the summary or full news article and only displays the news title of the currently viewed news item in newsfeed module.
ARTICLE_TOGGLE_FULLnoneToggles article in fullscreen in newsfeed module.

3rd Party Module notifications

Take a look in the wiki to see if 3rd party modules send notifications you might want to use.

Help us improve this page!
Last Updated:: 4/30/25, 8:00 PM
Prev
Logger
Next
Weather Module Weather Provider Development