Mercurial > prosody-modules

view mod_admin_notify/README.md @ 6355:77d565a6df4e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_pubsub_serverinfo: add 'common configuration issues' to readme
author Guus der Kinderen <guus.der.kinderen@gmail.com>
date Wed, 14 Jan 2026 13:59:01 +0100
parents fe081789f7b5
children
line wrap: on
line source

---
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.