Skip to content

Added Spike.sh support#1364

Merged
caronc merged 1 commit intomasterfrom
spike-support
Jul 6, 2025
Merged

Added Spike.sh support#1364
caronc merged 1 commit intomasterfrom
spike-support

Conversation

@caronc
Copy link
Owner

@caronc caronc commented Jul 6, 2025

Description:

Related issue (if applicable): #

Spike.sh Notifications

  • Source: https://www.spike.sh/
  • Icon Support: No
  • Message Format: Plain Text
  • Message Limit: ~20,000 Characters

Spike.sh is an incident response and on-call management platform. It supports sending alerts via webhook using a unique integration key.

Once you've created your alert source in Spike.sh, it will provide you with a webhook URL that looks like this:

https://api.spike.sh/v1/alerts/1234567890abcdef1234567890abcdef

This long key at the end is your integration key, which can be used directly in Apprise.


🛠️ Setup Instructions

  1. Log in to your Spike.sh dashboard.
  2. Go to Alert Sources and create a new source (e.g., for monitoring tools).
  3. Copy the provided Webhook URL.

✅ Apprise Support

You can use the full Spike.sh webhook URL directly, or simplify it using Apprise’s spike:// schema.

Syntax

Valid syntax is as follows:

  • https://api.spike.sh/v1/alerts/{integration_key}
  • spike://{integration_key}

🔐 Parameter Breakdown

Variable Required Description
integration_key Yes A 32-character token that uniquely identifies your Spike.sh alert source.

You can also use ?token=YOURKEY in the Apprise URL if you prefer.


📦 Examples

1. Using the simplified Apprise URL

# Assuming our token is 1234567890abcdef1234567890abcdef

apprise -vv -t "Spike Alert" -b "Incident occurred" \
   spike://1234567890abcdef1234567890abcdef

2. Using the token as a URL parameter

apprise -vv -t "Spike Alert" -b "Incident occurred" \
   spike://?token=1234567890abcdef1234567890abcdef

3. Using the full native webhook URL

apprise -vv -t "Spike Alert" -b "Incident occurred" \
   https://api.spike.sh/v1/alerts/1234567890abcdef1234567890abcdef

All formats above are supported and behave identically.


New Service Completion Status

  • apprise/plugins/spike.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@spike-support

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

@codecov
Copy link

codecov bot commented Jul 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.40%. Comparing base (02058d4) to head (09a50a0).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1364   +/-   ##
=======================================
  Coverage   99.40%   99.40%           
=======================================
  Files         165      166    +1     
  Lines       21858    21917   +59     
  Branches     3901     3906    +5     
=======================================
+ Hits        21727    21786   +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 dede5dd into master Jul 6, 2025
13 checks passed
@caronc caronc deleted the spike-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