Notificox

Notificox is a versatile tool designed to send messages to various services, inspired by the popular notification library, Apprise. It provides a unified interface to deliver notifications across multiple platforms, making it easier for users to manage and automate their communication needs.

With Notificox, you can send messages to a wide range of channels, including email, SMS, and instant messaging services.

This tool is a single dependency-free binary (only libc and SSL library are required), so you can run it anywhere, for example, in CI pipelines.

Some arguments are formatted in JSON5, so they can be entered in console without escape sequences.

Send notification locally

Usage:

notificox send <CREDENTIAL> [CONTACTS]... --context <CONTEXT>

Where:

• CONTEXT: JSON5-formatted message context object. Parameters are transport-specific. You can read about template parameters in Plugins section. Most of the transports require only "body" parameter to be set.
• CREDENTIAL: Transport credential. You can read about transport syntax in Plugins section.
• CONTACTS: zero or more contacts to send the message. The Contact format is transport-specific. Some transports, like Gotify, don't require contacts, as they only use credentials to send.

This command internally constructs a Notifico pipeline and executes it using the embedded pipeline engine. This process is fully transparent to end user.

Examples

Sending a Telegram message to recipient with chat_id=111579711 using telegram token:

notificox send "telegram:TOKEN" "telegram:111579711" -c "{body: 'my notification body'}"

notificox send "slack:TOKEN" "slack:CHAT_ID" -c "{body: 'my notification body'}" -a ~/file.pdf

notificox send "ntfy:https://ntfy.sh" "ntfy:notifico" -t template.toml -c "{username: 'USER1'}"

== template.toml ==
[parts]
body = "Hello from Notifico! Username: {{username}}"

Trigger an event on remote Notifico Ingest service

Usage:

notificox send-event [OPTIONS] --ingest <INGEST> <EVENT> <CONTEXT>