Services

Each service's fields and where to find them, the webhook's message, browser notifications and the server's mail.

Written for highsea 0.1.0.

Every service takes a Name and the events it hears, then fields of its own. Adding a connection walks through the dialog.

Each service

ServiceFieldsWhere to get them
DiscordWebhook address (needed), User nameIn the channel's settings: Integrations, Webhooks. Make a webhook there and copy its URL. User name changes the name messages are posted under.
SlackWebhook address (needed)An incoming webhook from your Slack app. The address starts with https://hooks.slack.com/.
TelegramBot token (needed), Chat (needed), Send silentlyMake a bot with @BotFather, which gives you the token. Chat is a chat id, or @channelname for a public channel. A bot can't start a conversation, so message it first, or add it to the group or channel.
ntfyServer address (needed), Topic (needed), Access token, User name, Password, Priorityhttps://ntfy.sh, or your own ntfy server. Subscribe to the same topic in the ntfy app. On a server with access control, give an access token or a user name and password. Priority runs from 1, the lowest, to 5, the highest; 3 to start with.
GotifyServer address (needed), Application token (needed), PriorityMake an application in your Gotify server's web interface; it gives you the token. Priority runs from 0 to 10; 5 to start with.
PushoverApplication token (needed), User key (needed), Device, PriorityRegister an application on pushover.net for its token; your user key is on your Pushover dashboard. Leave Device empty for all your devices. Priority runs from −2, the quietest, to 1, the most urgent; 0 to start with.
MatrixHomeserver (needed), Access token (needed), Room (needed)The homeserver's address, and the access token of the account that posts, which has to be in the room. Room is a room id like !abc:example.org, or an alias. A separate account for highsea keeps things tidy.
EmailSMTP server (needed), Port, Security, User name, Password, From (needed), To (needed)Your mail provider's SMTP settings. Security is STARTTLS (usually port 587, the default), TLS (usually port 465) or None, for a relay on your own network. From looks like highsea <media@example.org>; To is where notifications go.
WebhookAddress (needed), Method, Access token, User name, PasswordAny address that takes JSON. Method is POST or PUT. An access token is sent as a Bearer token; otherwise a user name and password are sent as basic authentication.
AppriseServer address (needed), Configuration key, Apprise URLs, TagThe address of an Apprise API server you run. Give the key of a configuration saved on it, or Apprise URLs to send to directly.
BrowserPeopleSee Browser notifications.

The webhook's message

A webhook gets one JSON body per message, with these fields:

{
  "event": "imported",
  "level": "success",
  "title": "Sintel (2010) is in the library",
  "body": "…",
  "text": "Sintel (2010) is in the library. …",
  "url": "https://harbor.example.net/…",
  "image": "…",
  "at": "2026-10-23T09:30:00.000Z",
  "payload": { }
}

text is the title and body in one line. url and image can be null. payload holds the event's own details.

Browser notifications

A Browser connection shows its messages as notifications in the browsers people have turned on.

  1. Add a Browser connection. Under People, choose whose browsers it reaches. Nobody chosen means just you.
  2. In each browser that should get notifications, open Settings › Connections and, under This browser, press Get notifications in this browser. The browser asks for permission.

This browser, at the foot of Settings › Connections: Get notifications in this browser, and a note that none of your browsers get notifications yet

Your browsers lists the ones you've turned on, and you can stop each one. Each person manages only their own.

Browsers allow this only when the admin is open over HTTPS, or on the computer highsea runs on. If the page says notifications are blocked, allow them for highsea's address in the browser's settings. See Network and remote access for HTTPS.

The server's mail

An Email connection can also send the server's own mail: invites and password resets, to each person's own address. Turn on Send the server's mail in the connection's dialog, or the Server's mail switch in its row. Only one connection sends it; turning it on for one turns it off for the others.

The Edit Household mail dialog: SMTP server smtp.example.org on port 587 with STARTTLS, a user name and saved password, From with a name and address, To, Test, the Events Health and Update, and Send the server's mail switched on

The Household mail connection's row, an Email connection hearing Health and Update, with its Server's mail switch on

Without one, invites and resets still work: Settings › Users and devices (People) shows each link to copy and send yourself. With one, the link is shown and emailed. Set the External URL in Network and remote access so links in emails reach the server from anywhere.

On this page