Mercurial > prosody-modules

view mod_admin_notify/README.markdown @ 4523:6e20e6bf96f0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Add XEP-0066 to mapping schema (breaking from previous jsonmap) before: oob_url: http://example.com/ after: oob: url: http://example.com/ desc: optional description Deals with the fact that the name and namespace differs based on whether it's in an iq or message stanza, unlike oob_url
author Kim Alvefur <zash@zash.se>
date Mon, 22 Mar 2021 23:14:25 +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.