https://github.com/seatgeek/mailroom

Framework for creating, routing, and delivering user notifications based on events from external systems
https://github.com/seatgeek/mailroom

golang notifications webhooks

Last synced: 3 days ago
JSON representation

Framework for creating, routing, and delivering user notifications based on events from external systems

• Host: GitHub
• URL: https://github.com/seatgeek/mailroom
• Owner: seatgeek
• License: apache-2.0
• Created: 2024-11-25T14:30:21.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2025-02-10T11:34:27.000Z (11 days ago)
• Last Synced: 2025-02-10T12:32:41.870Z (11 days ago)
• Topics: golang, notifications, webhooks
• Language: Go
• Homepage: https://chairnerd.seatgeek.com/mailroom-notification-framework/
• Size: 1.21 MB
• Stars: 538
• Watchers: 12
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# ![mailroom](./docs/mailroom.png)

[![GitHub Release](https://img.shields.io/github/v/release/seatgeek/mailroom?style=flat-square)](https://github.com/seatgeek/mailroom/releases)

[![Go Reference](https://pkg.go.dev/badge/github.com/seatgeek/mailroom.svg?style=flat-square)](https://pkg.go.dev/github.com/seatgeek/mailroom)

[![go.mod](https://img.shields.io/github/go-mod/go-version/seatgeek/mailroom?style=flat-square)](go.mod)

[![LICENSE](https://img.shields.io/github/license/seatgeek/mailroom?style=flat-square)](LICENSE)

[![Build Status](https://img.shields.io/github/actions/workflow/status/seatgeek/mailroom/tests.yml?branch=main&style=flat-square)](https://github.com/seatgeek/mailroom/actions?query=workflow%3Atests+branch%3Amain)

[![Go Report Card](https://goreportcard.com/badge/github.com/seatgeek/mailroom?style=flat-square)](https://goreportcard.com/report/github.com/seatgeek/mailroom)

[![Codecov](https://img.shields.io/codecov/c/github/seatgeek/mailroom?style=flat-square)](https://codecov.io/gh/seatgeek/mailroom)

Mailroom is a framework that simplifies the creation, routing, and delivery of user notifications based on events from external systems.

![Flow diagram](./docs/flow.png)

Mailroom is designed to be flexible and extensible, allowing you to easily add new handlers and transports as your needs grow and evolve. Simply write a function to transform incoming events into notifications, and Mailroom will take care of the rest, including:

- Acting as the primary notification relay for incoming webhooks from external systems

- Sending notifications to the appropriate users based on their preferences (e.g. PR reviews go to email, but build failures go to Slack)

- Formatting notifications for different transports (e.g. email, Slack, etc.)

- Matching usernames, emails, IDs, etc. across different systems

- Logging, error handling, retries, and more

See [`internal/example.go`](./internal/example.go) for an example of how to use mailroom.

## Documentation

- [Getting Started](./docs/getting-started.md)

- [Core Concepts](./docs/core-concepts.md)

- [Integrations](./docs/integrations.md)

Also see the [GoDoc](https://pkg.go.dev/github.com/seatgeek/mailroom) for documentation.

## Stability

Mailroom is currently in alpha. It works well in production, but the API may change at any time. We will do our best to note breaking changes in the release notes.

## Contributing

See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for contribution guidelines.

Use `make` to run all linters and tests locally.