AnandChowdhary/errol

Errol delivers your notifications wherever you want them. It’s a Node.js project that integrates with your favorite services, like Slack, Telegram, and, email.

Status
Build Node CI Dependencies GitHub release (latest by date) Snyk Vulnerabilities for GitHub Repo
Health License CI CLA Assistant Pull Request Labeler
PRs PR Generator CI Merge PRs

⭐️ Usage

To send a notification to all services:

import { Errol, ErrolService } from “errol”; // TypeScript/ESM
// const { Errol, ErrolService } = require(“errol”);

const notifications = new Errol([
  {
    service: ErrolService.SLACK,
    token: “your-slack-token”,
    channelId: “your-slack-channel”,
  },
  {
    service: ErrolService.TELEGRAM,
    accessToken: “your-telegram-token”,
    chatId: “your-telegram-chat”,
  },
  {
    service: ErrolService.EMAIL,
    from: “you@example.com”,
    to: “you@example.com”,
    host: “example.com”,
    auth: {
      user: “you@example.com”,
      pass: “your-password”,
    },
  },
]);

// Send a notification
notifications.send(“This is my notification!”);

Currently supported services:

  • Slack
  • Telegram
  • Email
  • Webhook
  • IFTTT
  • Twilio SMS
  • Twitter DM/tweet

📄 License

MIT © Koj