API Reference ex_ntfy v#0.1.0

An Elixir SDK for ntfy — a simple HTTP-based pub-sub notification service.

An ntfy action button.

An attachment on a received ntfy message.

Req-based HTTP client for the ntfy API.

Resolves client configuration with a fixed precedence: per-call options override application config (config :ex_ntfy, ...), which overrides library defaults.

The error type for all ExNtfy failures.

Behaviour for the handler consumption style of ExNtfy.subscribe/2.

A received ntfy message — the JSON schema shared by publish responses and subscribe events.

One-shot retrieval of cached messages — the poll=1 mode of the subscribe API (reference §2.1–§2.2). Usually called through the ExNtfy facade.

Validates publish options and encodes them for ntfy's three publish shapes

Publishing to ntfy topics — usually called through the ExNtfy facade.

WebSocket transport for ExNtfy.Subscription (format: :ws), subscribing via GET /<topics>/ws — requires the optional :mint_web_socket dependency

Validates subscribe options and builds subscribe URLs — shared infrastructure for one-shot polling (ExNtfy.poll/2, Phase 5) and the Phase 6 streaming subscriptions, which call path/2 with a stream format and to_query/1 without poll=1.

A long-lived subscription to ntfy topics — a GenServer owning one streaming HTTP connection, with automatic reconnect (resuming via since=<last id>), a keepalive watchdog, and two consumption styles.