Gotify smart home integration, free and open source
Gladys messages and scene notifications on your phone through your own Gotify server.
Published by guim31
- Messaging
- Version 1.0.1
- Requires Gladys >=5.1.0
- ★ 0
Receive the messages of Gladys on your phone through your own Gotify server, the self-hosted push notification server (Android app, web client): the messages of your scenes, the answers of Gladys and its system messages, plus notifications with a title, a priority, a link and an image from your scenes. Everything stays on your local network.
Developed without the hardware: feedback welcome. This integration was tested against a real Gotify 3.1.1 server, but not with the Gotify phone apps nor in a real Gladys installation. If something does not work as described, please say so on the Gladys forum or in the issues.
What you need
- Gladys Assistant 5.1.0 or later.
- A Gotify server that Gladys can reach on your network, for example the
gotify/serverDocker image (tested with Gotify 3.1.1). - The Gotify app on the phones that receive the notifications (Android, from F-Droid or Google Play), or the Gotify web interface open in a browser. Gotify has no official iOS app.
- One application token per Gotify account that receives messages. In the Gotify web interface, open the Apps tab, click Create application, name it (Gladys, for instance) and copy its token. An application token sends messages; a client token (tab Clients) reads them and does not work here.
Set up
Install the integration from Integrations → Install from GitHub with the
address https://github.com/guim31/gladys-gotify, then fill in its
Configuration screen:
- Gotify server address: the address you open Gotify with, port included,
for example
http://192.168.1.10:8080. A Gotify served under a path behind a reverse proxy (https://example.org/gotify) works too. - Shared application token: used by the scene action, the test, and the users who give no token of their own. Optional if every user fills in "My account".
- Default priority: the priority of the messages that do not set one. Default of the Gotify application leaves it to the application (its default priority is set in the Gotify web interface).
- Format messages as Markdown (on by default): Gladys writes bold text, lists and links in Markdown, and the Gotify apps display them.
- Accept a self-signed certificate: only for an
https://address whose certificate you created yourself. Leave it off otherwise. - Language of the integration texts: the note added to a message whose image could not follow, and the errors of the scene action.
Then click Send a test notification: the integration checks the server and sends a notification with the shared token.
My account: each Gladys user, admins and others, decides in the "My account" block of the integration's page whether they receive the messages Gladys sends them:
- Your application token: the token of an application of YOUR Gotify account, so that the messages reach your phone only. Leave it empty to use the shared token.
- Priority of your messages: your own priority, or Default of the integration.
Save at least one of the two: a user who saved nothing receives nothing. Delete my values stops the messages.
What Gladys sends
Every message Gladys sends to a user goes through Gotify when that user saved "My account": the Send Message scene action, the answers of Gladys, and its system messages (Gladys updated, backup failed, low battery…). In the Send Message action, recent versions of Gladys let you pick the channel: all channels, only Gotify, or Gladys only.
- The text is sent as Markdown, without a title: Gotify shows the name of the application instead.
- Gotify carries no attachment: the image of Send a camera image is left out, and a line says so under the text.
- The priority is the one of "My account", or the default priority.
What the priority does on the Gotify Android app:
| Priority | Notification |
|---|---|
| 0 | minimal: silent, no icon in the status bar |
| 1 to 3 | low: silent |
| 4 to 7 | normal: with sound |
| 8 to 10 | high: with sound and a pop-up over other apps |
The web client and the other apps may show priorities differently.
Dashboard
The Gotify widget shows:
- whether the server answers, and its version;
- the notifications sent today, and the failures with the last reason;
- the last notifications sent by scenes (title, date, priority, or "Not sent"). A tap opens the full text. The messages Gladys sends to one user are counted but never listed: the dashboard is seen by the whole household;
- a Send a test button, which does the same as the configuration test.
Scenes
Triggers
- Gotify server offline: the server stopped answering. It must fail two checks 30 seconds apart (a check runs every 5 minutes, and right after a failed delivery). Variable: the error.
- Gotify server back online: the server answers again after being offline. Variable: the Gotify version.
- Gotify notification not sent: a message could not be sent. Filters: the reason (server unreachable, token missing or refused, configuration incomplete, message refused) and who sent it (a Gladys message or the Gotify scene action). Variables: reason, origin, error. To avoid loops, it fires at most once per reason every 15 minutes.
The first state known after the installation, or after changing the address, is not announced: only a change is.
Actions
Send a Gotify notification, with the shared token:
- Title (optional): the name of the application otherwise.
- Message (required): Markdown when the option is on. Scene variables work here, as in every field.
- Priority: one of the list, or Default of the integration.
- Link opened on tap (optional): an
http://orhttps://address the phone opens when you tap the notification. - Image address (Android) (optional): an
https://image shown in the expanded notification of the Android app. Your phone downloads it: it must be reachable from the phone, not only from Gladys.
The action gives three values to the next actions of the scene:
Notification sent (yes / no), Gotify message number and Error
(empty when sent). A wrong field (an empty message, a link that is not
http(s)) fails the action, and the scene log says why.
Scene ideas
- Alarm: when the alarm goes off, Send a Gotify notification titled "Alarm", priority 8, with a link to your camera page.
- Fallback: on Gotify notification not sent with the reason "Server unreachable", send the message through another channel (SMS, e-mail). Do not answer it with another Gotify notification.
- Watch the server: on Gotify server offline, turn a lamp red; on Gotify server back online, turn it off.
Troubleshooting
The Configuration screen shows the state of the server. The messages:
- the Gotify server does not answer: check the address and the port, and
that the Gotify container is running. Gladys runs the integration in its own
Docker network:
localhostis the integration itself, use the IP address of the machine. - certificate refused: tick Accept a self-signed certificate, or use
the
http://address on your local network. - the address redirects: Gotify answered with a redirection, usually from
http://tohttps://. Enter thehttps://address. - no Gotify server at this address: another service answers there.
- application token refused by Gotify: the token is wrong, or the application was deleted in Gotify.
- this is a client token: copy the token from the Apps tab, not from the Clients tab.
- no application token: neither "My account" nor the configuration has one.
A user receives nothing? Check that they saved "My account", and that the Send Message action of the scene does not send to another channel only. The logs of the integration (Integrations → Gotify → Logs) give the details; they never show a token.
Limits
- Send only: Gotify has no replies. You cannot talk to Gladys from Gotify.
- No images nor files in messages: Gotify carries text only. The scene action can show an image from an address (Android only).
- The Gladys messages have no title of their own.
- Tested against a real Gotify 3.1.1 server, but not with the phone apps nor in a real Gladys.
- Gotify does not limit the number of messages; your phone may group or silence a flood of notifications.
This integration is not affiliated with the Gotify project.
Configuration settings
These are the settings Gotify asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Connect your Gotify server | section | No | In the Gotify web interface, open the Apps tab and create an application (name it Gladys, for instance), then paste its token below. Each Gladys user can also enter their own token in the "My account" block. |
| Gotify server address | string | Yes | The address you open Gotify with, port included. |
| Shared application token | secret | No | Used by the scene action, the test, and the users who give no token of their own. |
| Default priority | select | No | On the Gotify Android app: below 1 silent and discreet, 1 to 3 silent, 4 to 7 with sound, 8 and above with a pop-up. |
| Format messages as Markdown | boolean | No | Gladys writes bold text, lists and links in Markdown: the Gotify apps display them. |
| Accept a self-signed certificate | boolean | No | Only for an https:// address whose certificate you created yourself. |
| Language of the integration texts | select | No | Used for the notes added to the messages and the errors of the scene action. |
How to install Gotify in Gladys
- In Gladys, open Integrations: Gotify appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/guim31/gladys-gotify:1.0.1), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/guim31/gladys-gotify.
Gotify requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
Gotify is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by guim31, not by the Gladys core team.
- Browse all external integrations
- Discover the native integrations built into Gladys
- Build and publish your own external integration
- Source code on GitHub — source of this documentation