prosody-modules
a1f8cc591b66
mod_admin_notify/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

File

mod_admin_notify/README.markdown @ 5563:a1f8cc591b66

Back out 22784f001b7f: Documentation change did not match code (thanks bronko)
author Kim Alvefur <zash@zash.se>
date Thu, 22 Jun 2023 22:00:51 +0200
parent 4238:e97c509fdbe3
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.