Misskey Notifications

Overview

• Source: https://misskey-hub.net/
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 500

Account Setup

Sign up for any Misskey based service. Here are a few you can choose from today.

In Newer versions; the Access Token generation can be found in Settings -> Service Integration -> Generate Access Token (button).

Note: Other variations may provide Generate access token from the API menu item (it may vary depending on what version of misskey your chosen service is using).

While generating the token:

• Call it whatever you want
• At the bare minimum you need to grant the: Compose or delete notes
  

After you save your changes, you will be provided with the Access Token needed to work with Apprise.

Syntax

Valid syntax is as follows:

• misskey://{token}@{host}
• misskeys://{token}@{host}

Simply use misskey:// if accessing an insecure server and misskeys:// if accessing a secure one (https). In most cases, you’ll likely always be using misskeys://

Parameter Breakdown

Variable	Required	Description
token	Yes	The Access Token associated with the Application you created (in Misskey’s Account Settings). Your token MUST have at the bare minimum write:statuses access. Additionally provide write:media if you intend to provide attachments.
visibility	No	The Misskey visibility you want to operate in. Possible values are: 🔴 public: your note will be visible to all users and will show up on all timelines (home, local, social, global). Note: If your account is silenced, you cannot set your note visibility to public. 🔴 home: Your note will be visible to all users, but will not show up on the local, social or global timeline for non-followers. 🔴 followers: Your note will only be visible to those that are following you. The note will show up on all timelines of your followers. 🔴 specified: Your note will only be visible to individually specified users. The note will show up on all timelines of the specified users. If you enable this option, your note won’t be federated to remote instances.

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

Create a Misskey note on the misskey.sda1.net server :

# Assuming our {hostname} is misskey.sda1.net
# Assuming our {token} is abcdefghijklmn
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "misskeys://misskey.sda1.net/abcdefghijklmn"

This example builds on the last but leverages the visibility option::

# Assuming our {hostname} is misskey.sda1.net
# Assuming our {token} is abcdefghijklmn
# Assuming a {visibility} of home
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "misskeys://misskey.sda1.net/abcdefghijklmn?visibility=home"

Troubleshooting

1. WARNING - Failed to send Misskey notification: Method not allowed., error=405.
   • If the website is hosted as http (insecure) you must use misskey:// when assembling your Apprise URL where as if the website is https (secure hosting) you would use misskeys://
2. WARNING - Failed to send Misskey notification: error=403.
   • Make sure that the API Token you generated has the Compose or delete notes security setting enabled. You may need to regenerate a new key that includes this permission, otherwise verify you provided the correct token in your Apprise URL.