Apprise Notify
@sntxrr/apprise-notifyv2026.07.30.1
01README
Send notifications through an Apprise API server, fanning out to Matrix, Discord, ntfy, email and 100+ other services
02Models
@sntxrr/apprise-notifyv2026.07.30.1apprise_notify.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiUrl | string | Base URL of the Apprise API server, e.g. http://apprise:8000 |
| configKey? | string | Persistent config key to notify (POST /notify/<key>). Omit to use stateless mode, which requires `urls`. |
| urls? | string | Stateless mode: comma-separated Apprise URLs to notify directly (POST /notify). Ignored when configKey is set. Embeds credentials — supply via vault.get(). |
| defaultTags? | string | Comma-separated tags applied when a notify call does not specify its own. Must match tags on the configured URLs or nothing is sent. |
| timeoutMs | number | Abort the notification attempt after this long. Notifications should never hang a workflow. |
fn notify(title: string, body: string, type: enum, tags?: string, format: enum, when: boolean)
Post a notification to Apprise, optionally gated on a caller-supplied condition
| Argument | Type | Description |
|---|---|---|
| title | string | Notification title |
| body | string | Notification body. Honours `format` — use markdown for Matrix and Discord. |
| type | enum | Severity. Most targets render this as a colour or icon. |
| tags? | string | Comma-separated tags selecting which configured URLs to notify. Falls back to defaultTags. |
| format | enum | Body format passed to Apprise |
| when | boolean | Send only when true. Exists because swamp workflows cannot express predicate conditions — pass a CEL expression here instead. |
Resources
notification(infinite)— Record of a notification attempt: whether it was delivered, skipped, and what Apprise said
03Stats
A
100 / 100
Downloads
0
Archive size
8.0 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
Repository
https://github.com/sntxrr/swamp-apprise04Platforms
05Labels