HumHub Notifications

Overview

• Source: https://www.humhub.com/
• Image Support: No
• Attachment Support: Yes
• Message Character Limits:
  • Body: 4000
• Build Your Apprise URL

Account Setup

HumHub is a self-hosted social network for teams. To use this plugin you need a running HumHub instance with the REST API module installed and active.

Bearer Token (Recommended)

1. Log in to your HumHub instance as an administrator.
2. Navigate to Administration > Modules and confirm the REST API module is enabled.
3. Go to Administration > Authentication > REST API > Bearer Auth.
4. Enable Bearer token authentication and generate a new token.
5. Copy the generated token — this is your {token}.

Basic Authentication

You can also authenticate with your HumHub username and password directly. No additional setup is required beyond having a valid HumHub account.

Finding a Container ID

Each HumHub space has a numeric container ID. To find it:

1. Navigate to the space in your HumHub instance.
2. The ID appears in the space URL, for example https://yourhost/s/my-space-42 — the trailing number is the container ID.
3. Alternatively, query the REST API: GET /api/v1/space returns all spaces with their IDs.

Syntax

Valid syntax is as follows:

• humhubs://{token}@{hostname}/{container_id}
• humhubs://{user}:{password}@{hostname}/{container_id}
• humhubs://{token}@{hostname}/{id1}/{id2}/{id3}
• humhubs://{token}@{hostname}/?to={id1},{id2}
• humhubs://{token}@{hostname}:{port}/{container_id}
• humhub://{token}@{hostname}/{container_id}

Use humhubs:// for HTTPS connections (recommended) and humhub:// for plain HTTP.

Parameter Breakdown

Variable	Required	Description
hostname	*Yes	The hostname or IP address of your HumHub instance.
token	*Yes	A Bearer token generated in the HumHub admin panel (used when no password is provided).
user	*Yes	Your HumHub username (used together with password for Basic Authentication).
password	No	Your HumHub password. When provided, Basic Authentication is used instead of Bearer token authentication.
container_id	*Yes	The numeric ID of the HumHub space (container) to post to. Multiple IDs can be separated by / in the URL path, or provided as a comma-separated list via ?to=.
to	No	An alias for container_id. Accepts a comma-separated list of container IDs, useful in YAML configuration files where path-based targets are not convenient.
port	No	The port your HumHub instance listens on. Defaults to 80 for humhub:// and 443 for humhubs://.

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

Send a notification using a Bearer token:

# Assuming your HumHub hostname is hub.example.com
# Assuming your Bearer token is mytoken123
# Assuming your container ID is 5
apprise -vv -t "Alert" -b "Something happened" \
    "humhubs://mytoken123@hub.example.com/5"

Send to multiple spaces in one URL:

apprise -vv -t "Alert" -b "Something happened" \
    "humhubs://mytoken123@hub.example.com/1/5/12"

Send using Basic Authentication:

apprise -vv -t "Alert" -b "Something happened" \
    "humhubs://admin:mypassword@hub.example.com/5"

Send over HTTP (insecure, for development or LAN use only):

apprise -vv -t "Alert" -b "Something happened" \
    "humhub://mytoken123@hub.local/5"