2021-01-26 11:45:14 +02:00
< div align = "center" >
< img
width=40%
src="assets/gopher-letter.svg"
alt="notify logo"
/>
[](https://goreportcard.com/report/github.com/nikoksr/notify)
2021-01-26 11:54:06 +02:00
[](https://www.codacy.com/gh/nikoksr/notify/dashboard?utm_source=github.com& utm_medium=referral& utm_content=nikoksr/notify& utm_campaign=Badge_Grade)
2021-01-26 11:45:14 +02:00
[](https://codeclimate.com/github/nikoksr/notify/maintainability)
[](https://pkg.go.dev/github.com/nikoksr/notify)
< / div >
2021-01-26 12:39:02 +02:00
> <p align="center">A dead simple Go library for sending notifications to various messaging services.</p>
2021-01-26 11:45:14 +02:00
< h1 > < / h1 >
## About <a id="about"></a>
2021-02-12 20:20:07 +02:00
*Notify* was born out of my own need to have my API servers running in production be able to notify me when critical errors occur. Of course, _Notify_ can be used for any other purpose as well. The library is kept as simple as possible for quick integration and ease of use.
2021-01-26 11:45:14 +02:00
## Disclaimer <a id="disclaimer"></a>
Any misuse of this library is your own liability and responsibility and cannot be attributed to the authors of this library. See [license ](LICENSE ) for more.
Spamming through the use of this library **may get you permanently banned** on most supported platforms.
2022-02-13 19:18:03 +02:00
Since Notify is highly dependent on the consistency of the supported external services and the corresponding latest client libraries, we cannot guarantee its reliability nor its consistency, and therefore you should probably not use or rely on Notify in critical scenarios.
2021-01-26 11:45:14 +02:00
## Install <a id="install"></a>
2021-01-25 06:05:59 +02:00
```sh
go get -u github.com/nikoksr/notify
```
2021-01-26 11:45:14 +02:00
## Example usage <a id="usage"></a>
2021-01-25 06:05:59 +02:00
```go
2021-02-12 20:20:07 +02:00
// Create a telegram service. Ignoring error for demo simplicity.
2021-01-25 06:05:59 +02:00
telegramService, _ := telegram.New("your_telegram_api_token")
// Passing a telegram chat id as receiver for our messages.
2021-02-12 20:20:07 +02:00
// Basically where should our message be sent?
telegramService.AddReceivers(-1234567890)
2021-01-25 06:05:59 +02:00
// Tell our notifier to use the telegram service. You can repeat the above process
// for as many services as you like and just tell the notifier to use them.
2021-02-12 20:20:07 +02:00
// Inspired by http middlewares used in higher level libraries.
2022-02-09 15:10:08 +02:00
notify.UseServices(telegramService)
2021-01-25 06:05:59 +02:00
2021-02-12 20:20:07 +02:00
// Send a test message.
2022-02-09 15:10:08 +02:00
_ = notify.Send(
2021-02-18 04:33:30 +02:00
context.Background(),
2021-02-12 20:20:07 +02:00
"Subject/Title",
2021-02-18 04:33:30 +02:00
"The actual message - Hello, you awesome gophers! :)",
2021-01-25 06:05:59 +02:00
)
```
2022-04-26 00:17:02 +02:00
#### Recommendation <a id="recommendation"></a>
In this example, we use the global `Send()` function. Similar to most logging libraries such as
[zap ](https://github.com/uber-go/zap ), we provide global functions for convenience. However, as with most logging
libraries, we also recommend avoiding the use of global functions as much as possible. Instead, use one of our versatile
constructor functions to create a new local `Notify` instance and pass it down the stream.
2022-04-27 15:37:26 +02:00
Read the [library docs ](https://pkg.go.dev/github.com/nikoksr/notify#section-documentation ) for more information.
2022-04-26 00:17:02 +02:00
2022-04-22 21:24:34 +02:00
## Contributing <a id="contributing"></a>
2022-04-25 15:39:18 +02:00
Yes, please! Contributions of all kinds are very welcome! Feel free to check our [open issues ](https://github.com/nikoksr/notify/issues ). Please also take a look at the [contribution guidelines ](https://github.com/nikoksr/notify/blob/main/CONTRIBUTING.md ).
> Psst, don't forget to check the list of [missing services](https://github.com/nikoksr/notify/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aaffects%2Fservices+label%3A%22help+wanted%22+no%3Aassignee) waiting to be added by you or create [a new issue](https://github.com/nikoksr/notify/issues/new?assignees=&labels=affects%2Fservices%2C+good+first+issue%2C+hacktoberfest%2C+help+wanted%2C+type%2Fenhancement%2C+up+for+grabs&template=service-request.md&title=feat%28service%29%3A+Add+%5BSERVICE+NAME%5D+service) if you want a new service to be added.
2022-04-22 21:24:34 +02:00
2021-01-26 12:31:14 +02:00
## Supported services <a id="supported_services"></a>
2022-04-25 15:39:18 +02:00
> Click [here](https://github.com/nikoksr/notify/issues/new?assignees=&labels=affects%2Fservices%2C+good+first+issue%2C+hacktoberfest%2C+help+wanted%2C+type%2Fenhancement%2C+up+for+grabs&template=service-request.md&title=feat%28service%29%3A+Add+%5BSERVICE+NAME%5D+service) to request a missing service.
2022-02-13 19:18:03 +02:00
2022-10-25 09:00:35 +02:00
| Service | Path | Credits | Status |
|--------------------------------------------------------------------------------|------------------------------------------|-------------------------------------------------------------------------------------------------|:------------------:|
| [Amazon SES ](https://aws.amazon.com/ses ) | [service/amazonses ](service/amazonses ) | [aws/aws-sdk-go-v2 ](https://github.com/aws/aws-sdk-go-v2 ) | :heavy_check_mark: |
| [Amazon SNS ](https://aws.amazon.com/sns ) | [service/amazonsns ](service/amazonsns ) | [aws/aws-sdk-go-v2 ](https://github.com/aws/aws-sdk-go-v2 ) | :heavy_check_mark: |
| [Bark ](https://apps.apple.com/us/app/bark-customed-notifications/id1403753865 ) | [service/bark ](service/bark ) | - | :heavy_check_mark: |
| [DingTalk ](https://www.dingtalk.com ) | [service/dinding ](service/dingding ) | [blinkbean/dingtalk ](https://github.com/blinkbean/dingtalk ) | :heavy_check_mark: |
| [Discord ](https://discord.com ) | [service/discord ](service/discord ) | [bwmarrin/discordgo ](https://github.com/bwmarrin/discordgo ) | :heavy_check_mark: |
| [Email ](https://wikipedia.org/wiki/Email ) | [service/mail ](service/mail ) | [jordan-wright/email ](https://github.com/jordan-wright/email ) | :heavy_check_mark: |
| [Firebase Cloud Messaging ](https://firebase.google.com/docs/cloud-messaging ) | [service/fcm ](service/fcm ) | [appleboy/go-fcm ](https://github.com/appleboy/go-fcm ) | :heavy_check_mark: |
| [Lark ](https://www.larksuite.com/ ) | [service/lark ](service/lark ) | [go-lark/lark ](https://github.com/go-lark/lark ) | :heavy_check_mark: |
| [Line ](https://line.me ) | [service/line ](service/line ) | [line/line-bot-sdk-go ](https://github.com/line/line-bot-sdk-go ) | :heavy_check_mark: |
| [Line Notify ](https://notify-bot.line.me ) | [service/line ](service/line ) | [utahta/go-linenotify ](https://github.com/utahta/go-linenotify ) | :heavy_check_mark: |
| [Mailgun ](https://www.mailgun.com ) | [service/mailgun ](service/mailgun ) | [mailgun/mailgun-go ](https://github.com/mailgun/mailgun-go ) | :heavy_check_mark: |
| [Matrix ](https://www.matrix.org ) | [service/matrix ](service/matrix ) | [mautrix/go ](https://github.com/mautrix/go ) | :heavy_check_mark: |
| [Microsoft Teams ](https://www.microsoft.com/microsoft-teams ) | [service/msteams ](service/msteams ) | [atc0005/go-teams-notify ](https://github.com/atc0005/go-teams-notify ) | :heavy_check_mark: |
| [Plivo ](https://www.plivo.com ) | [service/plivo ](service/plivo ) | [plivo/plivo-go ](https://github.com/plivo/plivo-go ) | :heavy_check_mark: |
| [Pushbullet ](https://www.pushbullet.com ) | [service/pushbullet ](service/pushbullet ) | [cschomburg/go-pushbullet ](https://github.com/cschomburg/go-pushbullet ) | :heavy_check_mark: |
| [RocketChat ](https://rocket.chat ) | [service/rocketchat ](service/rocketchat ) | [RocketChat/Rocket.Chat.Go.SDK ](https://github.com/RocketChat/Rocket.Chat.Go.SDK ) | :heavy_check_mark: |
| [SendGrid ](https://sendgrid.com ) | [service/sendgrid ](service/sendgrid ) | [sendgrid/sendgrid-go ](https://github.com/sendgrid/sendgrid-go ) | :heavy_check_mark: |
| [Slack ](https://slack.com ) | [service/slack ](service/slack ) | [slack-go/slack ](https://github.com/slack-go/slack ) | :heavy_check_mark: |
| [Syslog ](https://wikipedia.org/wiki/Syslog ) | [service/syslog ](service/syslog ) | [log/syslog ](https://pkg.go.dev/log/syslog ) | :heavy_check_mark: |
| [Telegram ](https://telegram.org ) | [service/telegram ](service/telegram ) | [go-telegram-bot-api/telegram-bot-api ](https://github.com/go-telegram-bot-api/telegram-bot-api ) | :heavy_check_mark: |
| [TextMagic ](https://www.textmagic.com ) | [service/textmagic ](service/textmagic ) | [textmagic/textmagic-rest-go-v2 ](https://github.com/textmagic/textmagic-rest-go-v2 ) | :heavy_check_mark: |
| [Twilio ](https://www.twilio.com/ ) | [service/twilio ](service/twilio ) | [kevinburke/twilio-go ](https://github.com/kevinburke/twilio-go ) | :heavy_check_mark: |
| [Twitter ](https://twitter.com ) | [service/twitter ](service/twitter ) | [dghubble/go-twitter ](https://github.com/dghubble/go-twitter ) | :heavy_check_mark: |
| [WeChat ](https://www.wechat.com ) | [service/wechat ](service/wechat ) | [silenceper/wechat ](https://github.com/silenceper/wechat ) | :heavy_check_mark: |
| [WhatsApp ](https://www.whatsapp.com ) | [service/whatsapp ](service/whatsapp ) | [Rhymen/go-whatsapp ](https://github.com/Rhymen/go-whatsapp ) | :x: |
2022-09-01 10:52:20 +02:00
## Special Thanks <a id="special_thanks"></a>
### Maintainers <a id="maintainers"></a>
- [@svaloumas ](https://github.com/svaloumas )
### Logo <a id="logo"></a>
2022-02-13 19:18:03 +02:00
The [logo ](https://github.com/MariaLetta/free-gophers-pack ) was made by the amazing [MariaLetta ](https://github.com/MariaLetta ).
2021-01-25 06:05:59 +02:00
2022-04-22 21:24:34 +02:00
## Similar projects <a id="similar_projects"></a>
2021-01-25 06:05:59 +02:00
2022-04-22 21:24:34 +02:00
> Just to clarify, Notify was not inspired by any other project. I created it as a tiny subpackage of a larger project and only later decided to make it a standalone project. In this section I just want to mention other great projects.
- [containrrr/shoutrrr ](https://github.com/containrrr/shoutrrr )
- [caronc/apprise ](https://github.com/caronc/apprise )
2021-01-25 06:05:59 +02:00
2021-01-26 11:45:14 +02:00
## Show your support <a id="support"></a>
2021-01-25 06:05:59 +02:00
2021-02-12 20:20:07 +02:00
Give a ⭐️ if you like this project!
