mod_admin_notify/README.markdown
author Matthew Wild <mwild1@gmail.com>
Tue, 16 Apr 2024 12:05:47 +0100
changeset 5887 6c11e1b4066d
parent 4242 e97c509fdbe3
permissions -rw-r--r--
mod_http_admin_api: User activity gauges need to be summed (labels by host)

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