File

mod_admin_notify/README.markdown @ 5994:1bb8b559f441

misc/lnav: Fix invalid value warning lnav said warning: invalid value "/prosody_log/value/payload" reason: no patterns have a capture named "payload"
author Kim Alvefur <zash@zash.se>
date Thu, 03 Oct 2024 22:29:03 +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.