New:Introducing Socket Scanning for VS Code Marketplace Extensions.Learn more →
Get Started

@vymalo/medusa-apprise

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vymalo/medusa-apprise

A flexible notification plugin for MedusaJS using Apprise, enabling multichannel notifications with ease.

latest
Source
npmnpm
Version
1.0.2
Version published
Maintainers
1
Created
Source

MedusaJS Apprise Notification Plugin

A flexible notification plugin for MedusaJS using Apprise, enabling multichannel notifications with ease.

🌟 Features

  • Support for multiple notification channels (email, SMS, etc.)
  • Configurable via MedusaJS modules
  • Leverages Apprise's powerful notification routing
  • Flexible axios-based client configuration

📦 Installation

Install the package using npm:

npm install @vymalo/medusa-apprise

Or using yarn:

yarn add @vymalo/medusa-apprise

🚀 Usage

Configuration

Add the plugin to the modules section of your MedusaJS configuration:

modules: [
  {
    resolve: "@medusajs/medusa/notification",
    options: {
      providers: [
        {
          resolve: `@vymalo/medusa-apprise`,
          id: "apprise",
          options: {
            client: {
              baseURL: 'http://localhost:8000/notify', // Apprise API service URL
              headers: {
                "Content-Type": "application/json"
              }
            },
            handlers: {
              email: (notification: ProviderSendNotificationDTO) => [
                {
                  urls: [
                    `mailgun:///noreply@example.com/4b4f2918fd-dk5f-8f91f/${notification.to}`,
                    `ses://test@test.com/<access-key>/<secret-key>/<aws-region>/admin@email.com`,
                  ],
                  body: `[${notification.template}] ${JSON.stringify(notification.data, null, 4)}`
                }
              ],
              // More channel handlers...
            },
          },
        },
      ],
    },
  },
  // Other modules...
]

🔧 Configuration Options

Client Configuration

The client option uses axios configuration, allowing full customization of the HTTP client.

Handlers

Define custom handlers for different notification channels:

  • email: Email notification handler
  • sms: SMS notification handler
  • Add more as needed

Notification Payload

type AppriseNotificationPayload = {
  urls: string[];          // Notification destination URLs
  body: string;            // Notification body
  title?: string;          // Optional notification title
  type?: 'info' | 'warning' | 'failure';  // Notification type
  format?: 'text' | 'markdown' | 'html';  // Notification format
  tag?: string;            // Optional tag for notification
}

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

Check the license

Keywords

medusa

FAQs

Package last updated on 29 May 2025

Related posts