Skip to content

Ntfy

Upstream docs: https://docs.ntfy.sh/publish/

URL Format

URL Fields

  • Username - Auth username
    Default: empty
    URL part: ntfy://username:password@host/topic
  • Password - Auth password
    Default: empty
    URL part: ntfy://username:password@host/topic
  • Host - Server hostname and port
    Default: ntfy.sh
    URL part: ntfy://username:password@host/topic
  • Topic - Target topic name (Required)
    URL part: ntfy://username:password@host/topic

Query/Param Props

Props can be either supplied using the params argument, or through the URL using
?key=value&key=value etc.

  • Actions - Custom user action buttons for notifications, see https://docs.ntfy.sh/publish/#action-buttons
    Default: empty

  • Attach - URL of an attachment, see attach via URL
    Default: empty

  • Cache - Cache messages
    Default: ✔ yes

  • Click - Website opened when notification is clicked
    Default: empty

  • Delay - Timestamp or duration for delayed delivery, see https://docs.ntfy.sh/publish/#scheduled-delivery
    Default: empty
    Aliases: at, in

  • Email - E-mail address for e-mail notifications
    Default: empty

  • Filename - File name of the attachment
    Default: empty

  • Firebase - Send to firebase
    Default: ✔ yes

  • Icon - URL to use as notification icon
    Default: empty

  • Priority - Message priority with 1=min, 3=default and 5=max
    Default: default
    Possible values: Min, Low, Default, High, Max

  • Scheme - Server protocol, http or https
    Default: https

  • Tags - List of tags that may or not map to emojis
    Default: empty

  • Title - Message title
    Default: empty