Simplepush Notifications

Overview

• Source: https://simplepu.sh/
• Image Support: No
• Attachment Support: Yes
• Message Character Limits:
  • Body: 7000
• Supported Body Format(s):
  • ✓MARKDOWN
• Build Your Apprise URL

Account Setup

Simplepush delivers tasks and notifications to your phone. Every message Apprise sends arrives as a task in the Simplepush app, so it stays there after the push.

1. Install the Simplepush app and open its settings. Your API Token is listed there.

2. To send to a topic, create the topic in the app and have the recipients join it.

3. To send as an organization, an organization admin creates an integration token:

   sp integration create --scopes send

   The token looks like spi_<credential>.<seed>. Use it in place of the API Token.

Caution

URLs written for the previous Simplepush service (spush://{apikey}, spush://{salt}:{password}@{apikey} and the event= option) no longer work. Get a new API Token from the current Simplepush app and update your URLs.

End-to-End Encryption

Messages, links and attachments can be end-to-end encrypted with XChaCha20-Poly1305, the same scheme the Simplepush apps use:

• Topic send with a password: encrypted with that topic’s password.
• Send to your own devices with a password: encrypted with your Personal Password.
• Organization send: encrypted with the organization key whenever the organization has encryption turned on. Organization sends do not take a password.

Note

Encryption requires the PyNaCl Python package:

pip install PyNaCl

Without it, Apprise refuses to load a URL that has a password, and an organization send with encryption turned on fails. Apprise never falls back to sending your message unencrypted. Sends without encryption do not need PyNaCl.

Syntax

Valid syntax is as follows:

• spush://{api_token}
• spush://{api_token}/{topic}
• spush://{api_token}/{topic1}/{topic2}/{topicN}
• spush://{password}@{api_token}
• spush://{password}@{api_token}/{topic}
• spush://{integration_token}/{topic}
• spush://{integration_token}/@{member}
• spush://{integration_token}/{topic}/@{member1}/@{member2}
• spush://{integration_token}/?broadcast=yes

simplepush:// can be used in place of spush:// in any of these.

Parameter Breakdown

Variable	Required	Description
api_token	Yes	Your API Token from the app settings, or an organization integration token (spi_...).
password	No	Encrypts the message. With a topic it is the topic password, otherwise it is your Personal Password. Not allowed with an integration token.
topic	No	One or more topics. Each topic receives its own task.
@member	No	An organization member, prefixed with @. Requires an integration token.
to	No	Topics and @members as a comma separated list. An alternative to placing them in the URL path.
broadcast	No	Set to yes to send to every member of the organization. Requires an integration token and can not be combined with topics or members.
shared	No	Set to yes to send one task that all recipients see, where the first answer resolves it. By default every recipient gets their own copy.
priority	No	1 (silent) to 5 (critical, sounds even on a muted phone). The names minimal, low, default, high and critical also work. The default is 3.
critical_volume	No	The volume of the iOS critical alert sound, greater than 0 and at most 1. Requires priority=5.
sptag	No	The Simplepush tag shown on the task.
links	No	Links to attach to the task, separated by spaces. At most 25.
topic_auth_token	No	The auth token of a protected topic.

Global Parameters

Variable	Description
overflow	Controls messages that exceed a service’s documented limit. The default is upstream. 👉 upstream: Send one message without splitting or truncating it for that limit. 👉 truncate: Keep the portion that fits and discard the rest. 👉 split: Prefer a readable break, fall back to a hard boundary, and send every part in order. Splitting undeclared or structured content is best effort. Use upstream when the body must remain one intact document.
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 evaluates as 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 task to your own devices:

# Assume:
#  - our {api_token} is abcdefghijklmn
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   spush://abcdefghijklmn

Send to a topic, encrypted with the topic password:

# Assume:
#  - our {api_token} is abcdefghijklmn
#  - our {topic} is deploys
#  - the topic password is s3cret
apprise -vv -t "Deploy done" -b "Version 2.4 is live" \
   "spush://s3cret@abcdefghijklmn/deploys"

Send a critical alert with an attachment:

apprise -vv -t "Database down" -b "Primary is unreachable" \
   --attach /var/log/postgres.log \
   "spush://abcdefghijklmn/oncall?priority=5&critical_volume=0.5"

Send to two organization members:

# Assume:
#  - our {integration_token} is spi_cred.seed
apprise -vv -t "Site visit" -b "Please check the north gate" \
   "spush://spi_cred.seed/@Alice/@Bob"