Ntfy

Description

Rust library for sending notifications over ntfy.

Example

use ntfy::prelude::*;

#[tokio::main]
async fn main() -> Result<(), Error> {
    let dispatcher = dispatcher::builder("https://ntfy.sh")
        .credentials(Auth::credentials("username", "password")) // Add optional credentials
        //.proxy("socks5h://127.0.0.1:9050") // Add optional proxy (requires "socks" feature)
        .build_async()?; // Build dispatcher

    let action = Action::new(
        ActionType::Http,
        "Turn down",
        Url::parse("https://api.nest.com")?,
    );

    let payload = Payload::new("mytopic")
        .message("Hello, **World**!") // Add optional message
        .title("Alert") // Add optiona title
        .tags(["warning"]) // Add optional tags
        .priority(Priority::High) // Edit priority
        .actions([action]) // Add optional actions
        .click(Url::parse("https://example.com")?) // Add optional clickable url
        .attach(Url::parse("https://example.com/file.jpg")?) // Add optional url attachment
        .delay("30min") // Add optional delay
        .markdown(true); // Use markdown

    dispatcher.send(&payload).await?;

    Ok(())
}

Crate Feature Flags

The following crate feature flags are available:

Feature	Default	Description
`async`	Yes	Enables the async `dispatcher` and `subscriber`
`blocking`	No	Enables the blocking `dispatcher` and `subscriber`
`async-dispatcher`	Yes	Enables the async `dispatcher`
`blocking-dispatcher`	No	Enables the blocking `dispatcher`
`async-subscriber`	Yes	Enables the async and `subscriber`
`blocking-subscriber`	No	Enables the blocking and `subscriber`
`socks`	No	Enables socks proxy support
`rustls`	Yes	Enables rust TLS
`native-tls`	No	Enables native TLS (openssl)

More examples can be found in the examples directory.

Minimum Supported Rust Version (MSRV)

This project is built with the Rust language version 2024 and requires a minimum compiler version of 1.85.0.

License