Gotify Notifications

The gotify notification platform enables you to easily send notifications with a custom priority and extra information via Gotify.

Installation

HACS

You can easily install and update the integration using HACS. Click the 3 dots and "Custom repositories", then enter https://github.com/1RandomDev/homeassistant-gotify as repository and select type Integration. After clicking "Add" the Gotify Notifications integration should be downloadable in the store.

Manual

If you want to install it manually just download the repository as zip and extract it into <ha_config_dir>/custom_components/.

Configuration

This integration exposes itself as a notifications integration and configured by adding the folowing snippet to the configuration.yaml file:

notify:
  - name: "my gotify"
    platform: gotify
    url: <gotify_url>
    token: <gotify_token>
    verify_ssl: true # optional, default true
    msg_blacklist:   # optional, discard message if the text equals one of this strings
      - TTS

Replace <gotify_url> and <gotify_token> with the url of your Gotify instance and the application token to be used.

Usage

This integration accepts the same values as the official Gotify API. For a full list of extras that can be added to a notification refer to the Gotify docs. Here a few examples:

Simple text message

action:
  - service: notify.my_gotify
    data:
      message: "This is a test message."

Message with title and priority

action:
  - service: notify.my_gotify
    data:
      message: "This is a test message."
      title: "Gotify Test"
      data:
        priority: 10

Message with click event

action:
  - service: notify.my_gotify
    data:
      message: "This is a test message."
      title: "Gotify Test"
      data:
        priority: 10
        extras:
          'client::notification':
            click:
              url: https://www.home-assistant.io/

Message with image

action:
  - service: notify.my_gotify
    data:
      message: "This is a test message."
      title: "Gotify Test"
      data:
        priority: 10
        extras:
          'client::notification':
            bigImageUrl: https://placekitten.com/400/300

License

The whole project is under the GPL-3 license.