Gotify Notifications

Overview

• Source: https://github.com/gotify/server
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 32768

Syntax

Valid syntax is as follows:

• gotify://{hostname}/{token}
• gotifys://{hostname}/{token}
• gotifys://{hostname}:{port}/{token}
• gotifys://{hostname}/{path}/{token}
• gotifys://{hostname}:{port}/{path}/{token}
• gotifys://{hostname}/{token}/?priority=high

Secure connections (via https) should be referenced using gotifys:// where as insecure connections (via http) should be referenced via gotify://.

Parameter Breakdown

Variable	Required	Description
hostname	Yes	The Gotify server you’re sending your notification to.
token	Yes	The Application Token you generated on your Gotify Server
port	No	The port the Gotify server is listening on. By default the port is 80 for gotify:// and 443 for all gotifys:// references.
path	No	For those that host their Gotify server on a hostname that requires you to specify an additional path prefix may just include this as part of their URL string (the default is ’/’). What is important here is the final entry of your URL must still be the token.
priority	No	The priority level to pass the message along as. Possible values are low, moderate, normal, and high. If no priority is specified then normal is used.
format	No	The message format to announce to Gotify. By default all information is identified as text. But you can alternatively set this value to markdown as well.

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Examples

Send a Gotify message:

# Assuming our {hostname} is localhost
# Assuming our {token} is abcdefghijklmn
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "gotify://gotify.server.local/abcdefghijklmn"

# If your server is being hosted elsewhere and requires you to specify an
# additional path to get to it, you can notify it as follows:
# Assuming our {hostname} is localhost
# Assuming our {token} is abcdefghijklmn
# Assuming our {path} is /my/gotify/path/
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "gotify://gotify.server.local/my/gotify/path/abcdefghijklmn"

There is also markdown support if you want to leverage it; simply add format=markdown into your URL:

# Assuming our {hostname} is localhost
# Assuming our {token} is abcdefghijklmn
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "gotify://gotify.server.local/abcdefghijklmn?format=markdown"
#                                                ^      ^
#                                                |      |