view mod_admin_notify/README.md @ 6474:9112a0d25e5b

mod_firewall/README.md: fits definition of https://modules.prosody.im/stage_beta.html
author Menel <menel@snikket.de>
date Tue, 17 Mar 2026 19:52:50 +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.