Skip to content

Notify_misskey

Chris Caron edited this page Dec 17, 2024 · 5 revisions

Misskey Notifications

Account Setup

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

In the Settings of your account, you can access the API tab and create the Generate access token. This is what Apprise will use to send your notifications. image

While generating the token:

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

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.

Example

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"
Clone this wiki locally