Pinglet Notifications

Overview

• Source: https://pinglet.co.uk/
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Title: 250
  • Body: 3000
• Build Your Apprise URL

Account Setup

Sign in to your Pinglet account (or your self-hosted instance) and generate an API key from the account/API section.

Notifications are published to a topic within a namespace. Both are created automatically the first time you publish to them, so there is nothing to set up in the dashboard ahead of time.

Syntax

Secure connections (over HTTPS) should be referenced using pinglets://, whereas insecure connections (over HTTP) should be referenced using pinglet://.

Valid syntax is as follows:

• pinglet://{token}@{hostname}/{namespace}/{topic}
• pinglets://{token}@{hostname}/{namespace}/{topic}
• pinglets://{token}@{hostname}:{port}/{namespace}/{topic}
• pinglets://{token}@{hostname}{path}{namespace}/{topic}

The last form is for a self-hosted Pinglet server sitting behind a reverse-proxy path prefix, where {path} is the mount point (for example /pinglet/).

Parameter Breakdown

Variable	Required	Description
token	*Yes	Your Pinglet API key (can also be passed as ?token=)
hostname	*Yes	The hostname of your Pinglet server
port	No	The port your Pinglet server is listening on
namespace	*Yes	The namespace the topic resides in
topic	*Yes	The topic to publish to
priority	No	Delivery priority: silent, normal (default), or urgent
:key=value	No	Adds a badge (pill) to the notification card
+key=value	No	Adds metadata shown on the notification’s detail sheet

Note

Pinglet renders at most 3 badges per notification. Additional :key=value entries beyond the third are dropped, and any badge key longer than 24 characters or value longer than 32 characters gets truncated. Metadata (+key=value) keys are truncated at 64 characters and values at 256 characters.

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 simple Pinglet notification:

# Assuming our {token} is abc123
# Assuming our {hostname} is app.pinglet.co.uk
apprise -vv -t "Deploy Complete" -b "Build #482 shipped to production" \
   "pinglets://abc123@app.pinglet.co.uk/acme/deploys"

Send with a priority, a badge, and metadata:

apprise -vv -t "Deploy Complete" -b "Build #482 shipped to production" \
   "pinglets://abc123@app.pinglet.co.uk/acme/deploys?priority=urgent&:Host=web-1&+region=eu-west"

Send to a self-hosted instance mounted behind a reverse-proxy path prefix:

apprise -vv -t "Deploy Complete" -b "Build #482 shipped to production" \
   "pinglet://abc123@myhost/prefix/acme/deploys"