Session Open Group Server Notifications

Session Open Group Server

Overview

• Source: https://github.com/session-foundation/session-pysogs
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 32768
• Build Your Apprise URL

Account Setup

Session is a private, decentralised messaging application. A Session Open Group Server (SOGS) hosts publicly accessible community rooms. This plugin lets you post messages into one or more SOGS rooms using a bot identity.

You need two pieces of information: the server_key (the server’s public key) and a seed (your bot’s private Ed25519 seed). Both are 64 lowercase hex characters.

Step 1 — Generate a bot seed

The bot’s identity is a 64-hex Ed25519 seed (32 random bytes). Generate one in Python:

import os
print(os.urandom(32).hex())
# example output: a1b2c3d4e5f6...  (64 hex chars)

Keep this value secret — it is your seed. Anyone who holds it can post to any room your bot has been granted write access to.

Step 2 — Find the server_key

Every SOGS instance advertises a 64-hex Curve25519 server_key. You can find it in any Session group join link:

https://open.getsession.org/discussion?public_key=a03c383cf63c3c4e...

The public_key= value is the server_key you supply in the Apprise URL.

Step 3 — Find the room token

The room token is the path segment of the join link above (discussion in the example). It is a short alphanumeric slug that uniquely identifies the room on that server.

Step 4 — Grant the bot write access

A server administrator must add the bot’s Ed25519 public key to the room’s allowed list. The bot’s public key is derived automatically from your seed; you can display it with:

from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PrivateKey
from cryptography.hazmat.primitives.serialization import Encoding, PublicFormat

seed = bytes.fromhex("your_seed_here")
key  = Ed25519PrivateKey.from_private_bytes(seed)
print("00" + key.public_key().public_bytes(Encoding.Raw, PublicFormat.Raw).hex())

Syntax

Valid syntax is as follows:

• sessions://{public_key}:{seed}@{hostname}/{room}
• sessions://{public_key}:{seed}@{hostname}:{port}/{room}
• sessions://{public_key}:{seed}@{hostname}/{room1}/{room2}
• sogs://{public_key}:{seed}@{hostname}/{room}
• session://{public_key}:{seed}@{hostname}/{room}

Query-string form (useful in config files where embedding credentials in the URL authority is awkward):

• sessions://{hostname}/{room}?key={public_key}&seed={seed}
• sessions://{hostname}/{room}?public_key={public_key}&seed={seed}

Multiple rooms can be specified as additional path segments, or via ?to=:

• sessions://{public_key}:{seed}@{hostname}?to={room1},{room2}

Parameter Breakdown

Variable	Required	Description
hostname	Yes	The hostname (or IP address) of the SOGS server.
port	No	The port the server listens on. Defaults to 443 for sessions:// and 80 for session://.
key	Yes	The 64-hex Curve25519 public key of the SOGS server (from the Session join link ?public_key=). Also accepted as ?public_key=.
seed	Yes	The 64-hex Ed25519 seed that identifies the bot account. Treat it like a password — keep it secret.
room	Yes	One or more room tokens identifying the SOGS rooms to post into.
to	No	Comma-separated list of additional room tokens (alias for room path segments).

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.
redirect	By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this 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.
retry	The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries — a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt.
wait	The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero — a service with retry=0 makes exactly one attempt regardless of the wait value.
optional	When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still returns True even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic — all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller.

Examples

Post a notification to a public SOGS room over HTTPS:

# Assuming:
#   {public_key} = a03c383cf63c3c4ead6c4f0a29...  (64 hex chars, from join link)
#   {seed}       = a1b2c3d4e5f6...  (64 hex chars, your bot seed)
#   {hostname}   = open.getsession.org
#   {room}       = discussion

apprise -vv -t "Hello" -b "Test notification from Apprise" \
   "sessions://a03c383c...:a1b2c3d4...@open.getsession.org/discussion"

Post to two rooms in one command:

apprise -vv -b "Broadcast message" \
   "sessions://a03c383c...:a1b2c3d4...@open.getsession.org/room1/room2"

Use the plain HTTP schema for a locally hosted server without TLS:

apprise -vv -b "Local SOGS test" \
   "session://a03c383c...:a1b2c3d4...@localhost:8080/discussion"

Query-string style (useful in config files):

apprise -vv -b "Config-file style" \
   "sessions://open.getsession.org/discussion?key=a03c383c...&seed=a1b2c3d4..."