Skip to content

Vapid/WebPush Support #1323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Vapid/WebPush Support #1323

wants to merge 1 commit into from

Conversation

caronc
Copy link
Owner

@caronc caronc commented Apr 26, 2025

Description:

Related issue (if applicable): #1009

This is very much a work in progress

Account Setup

Vapid/WebPush requires a subscriptions.json file that identifies all of the users you wish to notify and a private_key.pem

Syntax:

  • vapid://subscription_id/
  • vapid://subscription_id/target
  • vapid://subscription_id/target1/target2/targetN/

Parameter Breakdown

Variable Required Description
keyfile Yes A private key in PEM format belonging to the account associated with the subscription_id
subfile Yes A subscriptions.json file identifying the configuration you wish to reference.

New Service Completion Status

  • apprise/plugins/vapid
  • 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@1009-webpush-support

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

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