apprise

extern/apprise

Fork 0

mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00

Table of Contents

Spontit Notifications

Syntax
Parameter Breakdown

Example

Spontit Notifications

Source: https://spontit.com
Icon Support: No
Message Format: Text
Message Limit: 5000 Characters per Message

Visit https://spontit.com to create your account.
To acquire your {user}: Visit your profile at https://spontit.com/profile and take note of your User ID here. It will look something like: user12345678901
To acquire your {apikey}: Generate an API key at https://spontit.com/secret_keys (if you haven't already done so).

Syntax

Channels are optional; if no channel is specified then you are just personally notified.

spontit://{user}@{apikey}
spontit://{user}@{apikey}/{channel_id}
spontit://{user}@{apikey}/{channel_id1}/{channel_id2}/{channel_idN}/

Parameter Breakdown

Variable	Required	Description
user	Yes	This is the User ID associated with your Spontit account. It can be found on your Spontit Profile page.
apikey	Yes	This is the API key you generated for your Spontit account. It can be found (and generated if it doesn't already exist) here.
channel_id	No	A Channel you wish to notify that you created.
subtitle	No	The subtitle of your push. Only appears on iOS devices.

Example

Send a Spontit notification to all devices associated with a project:

# Assume:
#  - our {user} is user28635710302
#  - our {apikey} is a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   spontit://user28635710302@a6k4ABnck26hDh8AA3EDHoOVdDEUlw3nty

# Override the subtitle (Mac users only) by doing the following:
# You must use URL encoded strings, below the spaces are swapped with %20
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   spontit://myuser@myapi?subtitle=A%20Different%20Subtitle

Quick Links:

📣 Apprise Notification Services and URL Examples
💡 Apprise CLI Tool Help
⚙️ Apprise Configuration Help
🌎 Apprise API/Web Interface