🔔 Notification Service API

Enterprise-grade notification management system with Pushover integration, persistent YAML storage, and REST API for cross-platform alerts.

📖 Table of Contents

• ✨ Features
• 🚀 Installation
• ⚙️ Configuration
• 💻 Node.js Usage
• 📡 API Reference
• 🔌 Pushover Integration Example
• 🏗 System Architecture
• 🛠 Development
• 📄 License
• ℹ️ Trademark Notice

✨ Features

🚀 Installation

# Clone and setup
git clone https://github.com/munirmardinli/pushover-notification.git
cd pushover-notification
npm install
Copy

⚙️ Configuration

Edit '.env' file:

# Server Configuration
PORT=9095

# Pushover Integration
PUSHOVER_USER_KEY=your_user_key
PUSHOVER_API_TOKEN=your_api_token

Copy

💻 Node.js Usage

import { App } from '@munirmardinli_org/pushover-notification';

// Initialize with custom port and storage path
const app = new App(
  parseInt(process.env.PORT || '9095'),
  './notifications.yaml'
);

// Start the notification service
app.start()
  .then(() => console.log('Notification service running'))
  .catch(err => console.error('Service failed:', err));
Copy

📡 API Reference

🔌 Pushover Integration Example

// Initialize service
const pushover = new PushoverService({
  userKey: process.env.PUSHOVER_USER_KEY,
  apiToken: process.env.PUSHOVER_API_TOKEN,
});

// Critical alert example
try {
  const receipt = await pushover.sendNotification({
    message: "Database cluster failure!",
    title: "🚨 PRODUCTION ALERT",
    priority: 2, // High priority
    sound: "siren",
    url: "https://status.example.com",
  });
  console.log(`Notification sent with receipt: ${receipt}`);
} catch (error) {
  console.error("Failed to send notification:", error);
}
Copy

🏗 System Architecture

src/
├── services/            # Service layer
│   ├── pushover.service.ts  # High-level API wrapper
│   └── pushover.ts      # Low-level HTTP client
├── types/               # Type definitions
│   └── globals.ts     # Shared interfaces
├── index.ts             # Express application
└── assets/              # Persistent storage
    └── notifications.yaml  # YAML data store
Copy

🛠 Development

# Run in development mode
npx tsx watch src/index.ts

# Build production version
npx tsc
Copy

📄 License

MIT License © Munir Mardinli

MIT License

Copyright (c) 2025 Munir Mardinli

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Copy

ℹ️ Trademark Notice

Trademark Disclaimer: ℹ️ Pushover® is a registered trademark of Superblock, Inc. ⚠️ This project is an independent, third-party implementation:

• Not affiliated with Superblock, Inc.
• Not officially endorsed by Pushover
• Not an official Pushover product

Proper Usage Guidelines:

• ✅ May refer to "Pushover API" for technical accuracy
• ✅ May state "compatible with Pushover"
• ❌ Cannot use Pushover logos or branding
• ❌ Cannot imply official partnership

For official Pushover services, visit: pushover.net