Nextcloud Notifications

Overview

• Source: https://nextcloud.com
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 4000

Account Setup

The official Notifications app will need to be installed. An ‘app password’ (also referred to as ‘device-specific’ password/token) of the admin-user will need to be created, see the documentation for more information. Don’t forget to disable file system access for this password.

Syntax

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

Valid syntax is as follows:

• ncloud://{hostname}/{targets}
• ncloud://{hostname}:{port}/{targets}
• ncloud://{admin_user}:{password}@{hostname}/{targets}
• ncloud://{admin_user}:{password}@{hostname}:{port}/{targets}
• nclouds://{hostname}/{targets}
• nclouds://{hostname}:{port}/{targets}
• nclouds://{admin_user}:{password}@{hostname}/{targets}
• nclouds://{admin_user}:{password}@{hostname}:{port}/{targets}

Targets can either be a user or @group.

You can notify more then one user by simply chaining them at the end of the URL.

• ncloud://{admin_user}:{password}@{hostname}/{notify_user1}/{notify_user2}/{notify_userN}
• nclouds://{admin_user}:{password}@{hostname}/{notify_user1}/{notify_user2}/{notify_userN}
• ncloud://{admin_user}:{password}@{hostname}/{notify_group1}/{notify_group2}/{notify_groupN}
• nclouds://{admin_user}:{password}@{hostname}/{notify_group1}/{notify_group2}/{notify_groupN}

You can mix/match @group and user values as well:

• ncloud://{admin_user}:{password}@{hostname}/{notify_group1}/{notify_user1}
• nclouds://{admin_user}:{password}@{hostname}/{notify_group1}/{notify_user1}

Parameter Breakdown

Variable	Required	Description
hostname	Yes	The hostname of the server hosting your Nextcloud service.
admin_user	Yes	The administration user of the next cloud service you have set up.
password	Yes	The administrator password associated with the admin_user for your Nextcloud account.
notify_user	Yes	One or more users you wish to send your notification to.
to	No	This is an alias to the notify_user variable.
version	No	NextCloud changed their API around with v21. By default Apprise uses their latest API spec. If you’re using an older version, you can sent this value accordingly and Apprise will accommodate (switching back to the older API).

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 secure nextcloud notification to the user chucknorris:

# Assuming our {host} is localhost
# Assuming our {admin_user} is admin
# Assuming our (admin) {password} is 12345-67890-12345-67890-12345:
apprise nclouds://admin:12345-67890-12345-67890-12345@localhost/chucknorris

Header Manipulation

Some users may require special HTTP headers to be present when they post their data to their server. This can be accomplished by just sticking a hyphen (-) in front of any parameter you specify on your URL string.

# Below would set the header:
#    X-Token: abcdefg
#
# We want to send an insecure connection (we'll use ncloud://)
# Assuming our {host} is localhost
# Assuming our {admin_user} is admin
# Assuming our (admin) {password} is 12345-67890-12345-67890-12345:
# We want to notify arnold
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   ncloud://admin:12345-67890-12345-67890-12345@localhost/arnold?-X-Token=abcdefg

# Multiple headers just require more entries defined with a hyphen in front:
# Below would set the headers:
#    X-Token: abcdefg
#    X-Apprise: is great
#
# Assuming our {host} is localhost
# Assuming our {admin_user} is admin
# Assuming our (admin) {password} is secret:
# We want to notify arnold
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   ncloud://admin:12345-67890-12345-67890-12345@localhost/arnold?-X-Token=abcdefg&-X-Apprise=is%20great

# If we're using an older version of NextCloud (their API changed) we may need
# to let Apprise know this (using the version= directive)
apprise -t "Title" -b "Body" "ncloud://admin:12345-67890-12345-67890-12345@localhost/arnold??version=20"

Users:

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host/user1/user2"

Group:

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host/#DevTeam"

Everyone:

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host/all"

Mixed (deduplicated):

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host/#DevTeam/user3/all"

Sub-path:

apprise -vv -t "Title" -b "Message" \
  "ncloud://admin:pass@host:8080/#Ops?url_prefix=/nextcloud"