Mercurial > prosody-modules

view mod_admin_notify/README.markdown @ 4748:a6b94f4fb065

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Correct unused reference $ref isn't supported yet, and this might not be the correct syntax, but now follows the other (un-)uses.
author Kim Alvefur <zash@zash.se>
date Thu, 04 Nov 2021 20:19:31 +0100
parents e97c509fdbe3
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.