webhook-alerts v1.1.1

Webhook Alerts

A simple package to send alerts via webhook at specified times using cron jobs.

Installation

npm install webhook-alerts

require('dotenv').config();
const { sendSingleAlert, sendMultipleAlert } = require('webhook-alerts');

// Example of sending a single alert
sendSingleAlert(process.env.WEBHOOK_URL, "Alert at 08:30 AM", "08:30");

// Example of sending multiple alerts
sendMultipleAlert(process.env.WEBHOOK_URL, "Alert at multiple times", ["08:30", "12:30", "17:30"]);

Methods

sendSingleAlert(webhookURL, alertText, alertTime, day, month, daysOfWeek)

Schedules a single alert.

• webhookURL: The URL of the webhook.
• alertText: The text of the alert.
• alertTime: Time in HH:MM(00:00-23:59) format(if not specified then the alert will be sent at 8:30AM daily ).
• day: (Optional) Day of the month to send the alert. Default is *.
• month: (Optional) Month to send the alert. Default is *.
• daysOfWeek: (Optional) Days of the week to send the alert. Default is *.

sendMultipleAlert(webhookURL, alertText, alertTimes, day, month, daysOfWeek)

Schedules multiple alerts.

• webhookURL: The URL of the webhook.
• alertText: The text of the alert.
• alertTimes: An array of times in HH:MM format.
• day: (Optional) Day of the month to send the alert. Default is *.
• month: (Optional) Month to send the alert. Default is *.
• daysOfWeek: (Optional) Days of the week to send the alert. Default is *.

Example

Here’s an example of how you can use the package:

require('dotenv').config();
const { sendSingleAlert, sendMultipleAlert } = require('webhook-alerts');

// Send a single alert at 08:30 AM every day of every month, every weekday
sendSingleAlert(process.env.WEBHOOK_URL, "Reminder: Check your schedule!", "08:30", "*", "*", "1-5");

// Send multiple alerts at 08:30 AM, 12:30 PM, and 17:30 PM every day of every month, every weekday
sendMultipleAlert(process.env.WEBHOOK_URL, "Reminder: Check your schedule!", ["08:30", "12:30", "17:30"], "*", "*", "1-5");

Release Notes

Version 1.0.0

• Initial release of the webhook-alerts package.
• Added sendSingleAlert method for scheduling a single alert with customizable time, day, month, and weekday options.
• Added sendMultipleAlert method for scheduling multiple alerts at specified times with similar scheduling options.
• Supports flexible cron-like scheduling using the node-cron package.
• Integrated with dotenv for managing environment variables.