mod_admin_notify/README.markdown
author Nicholas George <wirlaburla@worlio.com>
Sat, 08 Jun 2024 03:28:25 -0500
changeset 5926 f408b8e603af
parent 4242 e97c509fdbe3
permissions -rw-r--r--
mod_server_info: fix dataforms require

---
labels:
- 'Stage-Alpha'
summary: API to notify server admins
---

# Introduction

This module provides an API for other module developers to send
notification messages to host admins.

# Configuration

None required.

# Developers

Example:

```
local notify_admins = module:depends("admin_notify").notify;

notify("This is an important message for you, admins")
```

# Compatibility

Prosody trunk or later. Incompatible with 0.11 or lower.