2 Notify_synology_chat
Chris Caron edited this page 2023-12-28 13:24:20 -05:00

Synology Notifications

Syntax

Valid syntax is as follows:

  • synology://{hostname}}/{token}
  • synology://{hostname}:{port}/{token}
  • synology://{user}:{password}@{hostname}/{token}
  • synology://{user}:{password}@{hostname}:{port}/{token}

The secure versions (https):

  • synologys://{hostname}/{token}
  • synologys://{hostname}:{port}/{token}
  • synologys://{user}:{password}@{hostname}/{token}
  • synologys://{user}:{password}@{hostname}:{port}/{token}

Parameter Breakdown

Variable Required Description
hostname Yes The Web Server's hostname
token Yes The Synology Chat Incoming Token generated
port No The port our Web server is listening on. By default the port is 80 for synology:// and 443 for all synologys:// references.
user No If you're system is set up to use HTTP-AUTH, you can provide username for authentication to it.
password No If you're system is set up to use HTTP-AUTH, you can provide password for authentication to it.
file_url No Synology allows you to directly link to a URL containing an attachment. If you set this on the Apprise URL, it will be passed down to the synology request made under the hood.

Example

Send a Synology notification to all devices associated with a project:

# Assume:
#  - our {hostname} is synology.home.arpa
#  - our {port} is 5000
#  - our {token} is j300012fl9y0b5AW9g9Nsejb8P
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   synology://synology.home.arpa:5000/j300012fl9y0b5AW9g9Nsejb8P