view mod_admin_notify/README.markdown @ 4246:53ae1df31950

mod_rest/example: Advertise version query support
author Kim Alvefur <zash@zash.se>
date Sun, 15 Nov 2020 15:28:14 +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.