https://github.com/notifiex/notifiex
A dead simple Elixir library for sending notifications to various messaging services. (supports file uploads, multiple notification dispatching, and much more! ✨)
https://github.com/notifiex/notifiex
discord elixir library messaging notification-service notifications slack
Last synced: 5 months ago
JSON representation
A dead simple Elixir library for sending notifications to various messaging services. (supports file uploads, multiple notification dispatching, and much more! ✨)
- Host: GitHub
- URL: https://github.com/notifiex/notifiex
- Owner: notifiex
- License: mit
- Created: 2022-05-03T17:59:04.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-26T16:17:23.000Z (over 2 years ago)
- Last Synced: 2025-12-13T02:00:07.030Z (7 months ago)
- Topics: discord, elixir, library, messaging, notification-service, notifications, slack
- Language: Elixir
- Homepage: https://hex.pm/packages/notifiex
- Size: 215 KB
- Stars: 71
- Watchers: 2
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[ci]: https://github.com/burntcarrot/notifiex/actions/workflows/elixir.yml
[ci-badge]: https://github.com/burntcarrot/notifiex/actions/workflows/elixir.yml/badge.svg
[](https://hex.pm/packages/notifiex)
[![Actions status][ci-badge]][ci]
> ❤️ If you're using Notifiex for your project, or in your company, please say a hi 👋 [here!](https://github.com/burntcarrot/notifiex/issues/1)
**Why Notifiex?**
- 📦 Easy-to-use, supports multiple [services](#services)!
- ⬆️ File upload support! (_to the notification services that will accept them_)
- ⚡ Incredibly lightweight (_minimal dependencies_)
- 🤹 Asynchronous notification dispatching (using Tasks and Supervisor)
Table of Contents:
- [Installation](#installation)
- [Usage](#usage)
- [Services](#services)
- [Plugins](#plugins)
- [File Uploads](#file-uploads)
- [License](#license)
- [Acknowledgements](#acknowledgements)
## Installation
[Notifiex](https://hex.pm/packages/notifiex) can be installed
by adding `notifiex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:notifiex, "~> 1.2.0"}
]
end
```
## Usage
Here is an example on how Notifiex sends a Slack message:
```elixir
> Notifiex.send(:slack, %{text: "Notifiex is cool! 🚀", channel: "general"}, %{token: "SECRET"})
```
Sending a Discord message:
```elixir
> Notifiex.send(:discord, %{content: "Notifiex is cool! 🚀"}, %{webhook: "SECRET"})
```
Sending in async mode (through Tasks and Supervisors):
```elixir
> Notifiex.send_async(:discord, %{content: "Notifiex is cool! 🚀"}, %{webhook: "SECRET"})
```
Sending multiple messages:
```elixir
notifs = [
slack_test: {:slack, %{text: "Notifiex is cool! 🚀", channel: "general"}, %{token: "SECRET"}},
discord_test: {:discord, %{content: "Notifiex is cool! 🚀"}, %{webhook: "SECRET"}}
]
# send synchronously
Notifiex.send_multiple(notifs)
# send in async mode
Notifiex.send_async_multiple(notifs)
```
## Services
Notifiex currently supports these services:
- [x] Slack (check [guide](https://github.com/burntcarrot/notifiex/blob/main/guides/slack.md) 📖)
- [x] Discord (check [guide](https://github.com/burntcarrot/notifiex/blob/main/guides/discord.md) 📖)
## Plugins
> 📢 Notifiex now supports custom plugins! [Here's a complete guide](https://github.com/burntcarrot/notifiex/blob/main/guides/plugins.md) on creating and using plugins!
As a starter, you can create a plugin for any of these services:
- [ ] Linear
- [ ] Mailgun
- [ ] Microsoft Teams
- [ ] SendGrid
- [ ] Plivo
- [ ] Telegram
- [ ] Twitter
- [ ] Zulip
- [ ] Rocket.Chat
- [ ] Google Chat
- [ ] Mattermost
## File Uploads
Notifiex supports uploading files (text-based, binaries, etc.) to:
- [x] Slack
- [ ] Discord
## License
Notifiex is licensed under the MIT License.
## Acknowledgements
notifiex is inspired by [ravenx](https://github.com/acutario/ravenx). Please do check out their project!