Repository files navigation

A dead simple Go library for sending notifications to various messaging services.

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.

Any misuse of this library is your own liability and responsibility and cannot be attributed to the authors of this library. Seelicense for more.

Spamming through the use of this librarymay get you permanently banned on most supported platforms.

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.

go get -u github.com/nikoksr/notify

// Create a telegram service. Ignoring error for demo simplicity.telegramService,_:=telegram.New("your_telegram_api_token")// Passing a telegram chat id as receiver for our messages.// Basically where should our message be sent?telegramService.AddReceivers(-1234567890)// 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.// Inspired by http middlewares used in higher level libraries.notify.UseServices(telegramService)// Send a test message._=notify.Send(context.Background(),"Subject/Title","The actual message - Hello, you awesome gophers! :)",)

In this example, we use the globalSend() function. Similar to most logging libraries such aszap, we provide global functions for convenience. However, as with most logginglibraries, we also recommend avoiding the use of global functions as much as possible. Instead, use one of our versatileconstructor functions to create a new localNotify instance and pass it down the stream.

Yes, please! Contributions of all kinds are very welcome! Feel free to check ouropen issues. Please also take a look at thecontribution guidelines.

Psst, don't forget to check the list ofmissing services waiting to be added by you or createa new issue if you want a new service to be added.

Clickhere to request a missing service.

• @svaloumas

Thelogo was made by the amazingMariaLetta.

If you find this project useful, consider giving it a ⭐️! Your support helps bring more attention to the project, allowing us to enhance it even further.

While you're here, feel free to check out my other work:

• nikoksr/konfetty - Zero-dependency, type-safe and powerful post-processing for your existing config solution in Go.