iobroker.gotify

v0.5.0

Published

22 days ago

Send push notifications to gotify

0High
0Medium
0Low

bluefox

thomaspohl

gotify notification communication ioBroker

Logo

ioBroker.gotify

Number of Installations (latest) Number of Installations (stable)

Tests:

gotify adapter for ioBroker

Send push notifications from ioBroker to Gotify

Changelog

0.5.0 (2025-12-28)

(Thomas Pohl) Allow to overwrite token when sending messages (javascript only not for blockly)
(Thomas Pohl) Update dependencies

0.4.0

(Thomas Pohl) Support for notification-manager was added
(Thomas Pohl) Blockly can now send messages with priority 10

0.3.0

(Thomas Pohl) The token is stored now encrypted
(Thomas Pohl) node.js 22 is supported

0.2.1

(Thomas Pohl) Optimized startup behavior when adapter is not configured

0.2.0

(Thomas Pohl) Add timeout for http calls
(Thomas Pohl) Update dependency versions

Installation

Preparation

Login with you user in gotify
Create an application for ioBroker
Note the token of your new application

In ioBroker

Goto Adapter
Click on github-cat-icon
Go to Custom tab
Enter https://github.com/ThomasPohl/ioBroker.gotify
Install
Create a new instance for the gotify-adapter
Enter the Url auf you installation
Add the previously created token

Usage

Blockly

To send messages using blockly. Just add the gotify block to your script: Blockly

If yoou choose Markdown as format you can use Markdown to format your messages.

Javascript

Send a simple message using the default token:

sendTo('gotify.0', 'send', {
    title: 'DG lüften',
    message: 'Luftfeuchtigkeit im DG zu hoch!',
});

Send a message with a custom token (overrides the configured default token):

sendTo('gotify.0', 'send', {
    title: 'Custom notification',
    message: 'This message uses a different token',
    priority: 8,
    contentType: 'text/markdown',
    token: 'AaBbCcDdEeFfGg123456',
});

Communication

The following diagramm illustrates how ioBroker sends push notifications to your smartphone. Communication diagram

Both the ioBroker and the smartphone app connect to the gotify server using REST. The mobile app keeps an open websocket to the gotify server to be able to receive new notification.

When the ioBroker-adapter wants to push a notification it send a POST request to the Gotify server. The gotify server takes care of pushing the notification to the client.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.