# ntfy - ntfy notifications

Warning

Do not commit your credentials to a public repo!

Send alerts using the ntfy service.

topic
  Type:

    string

  Required:

    true

  the ntfy topic to send to

priority
  Type:

    str or int

  Required:

    false

  Default:

    `default`

  the priority to use for notifications. an int 1 to 5 (1 is lowest, 5 is highest), or one of `max`, `high`, `default`, `low`, `min`

tags
  Type:

    string

  Required:

    false

  the tags to add to the notification. A comma-separated list of strings

token
  Type:

    string

  Required:

    false

  your token for ntfy, if required

server
  Type:

    string

  Required:

    false

  Default:

    `https://ntfy.sh`

  the server to send to

timeout
  Type:

    int

  Required:

    false

  Default:

    `5`

  Timeout for HTTP request

icon_prefix
  Type:

    bool

  Required:

    false

  Default:

    false

  Prefix the subject line with an icon dependent on the result (failed/succeeded)

icon_failed
  Type:

    str

  Required:

    false

  Default:

    `274C`

  Unicode code for the “failed” icon. The code is often provided as “U+<code>” (e.g. `U+274C`). The default icon for the failed status is ❌.

icon_succeeded
  Type:

    str

  Required:

    false

  Default:

    `2705`

  Unicode code for the “succeeded” icon. The code is often provided as “U+<code>” (e.g. `U+2705`). The default icon for the failed status is ✅.