notify

README

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

About

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.

Disclaimer

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

Spamming through the use of this library may 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.

Install

go get -u github.com/nikoksr/notify

Example usage

// 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! :)",
)

Supported services

Please create feature requests for missing services (see #3 for example)

Service	Path	Credits
Amazon SES	service/amazonses	aws/aws-sdk-go-v2
Amazon SNS	service/amazonsns	aws/aws-sdk-go-v2
DingTalk	service/dinding	blinkbean/dingtalk
Discord	service/discord	bwmarrin/discordgo
Email	service/mail	jordan-wright/email
Line	service/line	line/line-bot-sdk-go
Line Notify	service/line	utahta/go-linenotify
Mailgun	service/mailgun	mailgun/mailgun-go
Microsoft Teams	service/msteams	atc0005/go-teams-notify
Plivo	service/plivo	plivo/plivo-go
Pushbullet	service/pushbullet	cschomburg/go-pushbullet
RocketChat	service/rocketchat	RocketChat/Rocket.Chat.Go.SDK
SendGrid	service/sendgrid	sendgrid/sendgrid-go
Slack	service/slack	slack-go/slack
Syslog	service/syslog	log/syslog
Telegram	service/telegram	go-telegram-bot-api/telegram-bot-api
TextMagic	service/textmagic	textmagic/textmagic-rest-go-v2
Twitter	service/twitter	dghubble/go-twitter
WeChat	service/wechat	silenceper/wechat
WhatsApp	service/whatsapp	Rhymen/go-whatsapp

Logo

The logo was made by the amazing MariaLetta.

Contributing

Contributions, issues and feature requests are very welcome! Feel free to check issues page. Please also take a look at the contribution guidelines.

Show your support

Give a ⭐️ if you like this project!

Documentation

Index

• Variables
• func Send(ctx context.Context, subject, message string) error
• func UseServices(service ...Notifier)
• type Notifier
• type Notify
  • func Default() *Notify
  • func New() *Notify
  • func (n *Notify) Send(ctx context.Context, subject, message string) error
  • func (n *Notify) UseServices(service ...Notifier)

Variables

var ErrSendNotification = errors.New("send notification")

ErrSendNotification signals that the notifier failed to send a notification.

Functions

func Send

func Send(ctx context.Context, subject, message string) error

Send calls the underlying notification services to send the given subject and message to their respective endpoints.

func UseServices

func UseServices(service ...Notifier)

UseServices adds the given service(s) to the Notifier's services list.

Types

type Notifier

type Notifier interface {
	Send(context.Context, string, string) error
}

Notifier defines the behavior for notification services.

The Send function simply sends a subject and a message string to the internal destination Notifier.

E.g. for telegram.Telegram it sends the message to the specified group chat.

type Notify

type Notify struct {
	Disabled bool
	// contains filtered or unexported fields
}

Notify is the central struct for managing notification services and sending messages to them.

func Default

func Default() *Notify

Default returns the standard Notify instance used by the package-level send function.

func New

func New() *Notify

New returns a new instance of Notify. Defaulting to being not disabled.

func (*Notify) Send

func (n *Notify) Send(ctx context.Context, subject, message string) error

Send calls the underlying notification services to send the given subject and message to their respective endpoints.

func (*Notify) UseServices

func (n *Notify) UseServices(service ...Notifier)

UseServices adds the given service(s) to the Notifier's services list.