Skip to content

Added Spug Push Support#1365

Merged
caronc merged 1 commit intomasterfrom
spugpush-support
Jul 7, 2025
Merged

Added Spug Push Support#1365
caronc merged 1 commit intomasterfrom
spugpush-support

Conversation

@caronc
Copy link
Owner

@caronc caronc commented Jul 7, 2025

Description:

Related issue (if applicable): n/a

SpugPush Notifications

  • Source: https://push.spug.dev/
  • Icon Support: No
  • Message Format: Plain Text
  • Message Limit: ~10,000 Characters

SpugPush is a simple webhook service provided by the Spug monitoring platform. It allows applications to send alert messages using a secure access token.


🛠️ Setup Instructions

  1. Visit the SpugPush service.
  2. Sign in and generate your token.
  3. Copy the full webhook URL, which will look like:
https://push.spug.dev/send/abc123def456ghi789jkl012mno345pq

The token portion at the end is the only value Apprise requires.


✅ Apprise Support

Apprise supports both the full native webhook and a simplified URL form.

Syntax

Valid syntax is as follows:

  • https://push.spug.dev/send/{token}
  • spugpush://{token}

🔐 Parameter Breakdown

Variable Required Description
token Yes The 32–64 character SpugPush token used to authenticate the request.

You may also use the query format: spugpush://?token=YOUR_TOKEN.


📦 Examples

1. Using the simplified Apprise URL

apprise -vv -t "SpugPush Title" -b "Notification content" \
   spugpush://abc123def456ghi789jkl012mno345pq

2. Using the token as a query parameter

apprise -vv -t "SpugPush Title" -b "Notification content" \
   spugpush://?token=abc123def456ghi789jkl012mno345pq

3. Using the full native webhook URL

apprise -vv -t "SpugPush Title" -b "Notification content" \
   https://push.spug.dev/send/abc123def456ghi789jkl012mno345pq

All forms are valid and supported equally by Apprise.

New Service Completion Status

  • apprise/plugins/spugpush.py
  • KEYWORDS
    • add new service into this file (alphabetically).
  • README.md
    • add entry for new service to table (as a quick reference)
  • packaging/redhat/python-apprise.spec
    • add new service into the %global common_description

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • No lint errors (use flake8)
  • 100% test coverage

Testing

Anyone can help test this source code as follows:

# Create a virtual environment to work in as follows:
python3 -m venv apprise

# Change into our new directory
cd apprise

# Activate our virtual environment
source bin/activate

# Install the branch
pip install git+https://github.com/caronc/apprise.git@spugpush-support

# Test out the changes with the following command:
apprise -t "Test Title" -b "Test Message" \
 "spugpush://token"

@codecov
Copy link

codecov bot commented Jul 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.40%. Comparing base (91d7b92) to head (f033184).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1365   +/-   ##
=======================================
  Coverage   99.40%   99.40%           
=======================================
  Files         167      168    +1     
  Lines       21975    22034   +59     
  Branches     3911     3916    +5     
=======================================
+ Hits        21844    21903   +59     
  Misses        121      121           
  Partials       10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@caronc caronc merged commit 1d5a304 into master Jul 7, 2025
13 checks passed
@caronc caronc deleted the spugpush-support branch August 1, 2025 22:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant