NotifyHub

One API. Every channel.
Unified notification library for Java and Spring Boot.

Website  ·  Documentation  ·  Getting Started

Stop writing different code for each notification channel. NotifyHub gives you a single fluent API to send notifications via Email, SMS, WhatsApp, Slack, Telegram, Discord, Microsoft Teams, Firebase Push, Webhooks, WebSocket, Google Chat, Twitter/X, LinkedIn, Notion, Twitch, YouTube, Instagram, SendGrid, TikTok Shop, Facebook, AWS SNS, Mailgun, PagerDuty, Kick — or any custom channel you create.

notify.to(user)
    .via(EMAIL)
    .fallback(SMS)
    .priority(Priority.HIGH)
    .subject("Order confirmed")
    .template("order-confirmed")
    .param("orderId", order.getId())
    .attach(invoicePdf)
    .send();

Why NotifyHub?

	Problem	Without NotifyHub	With NotifyHub
	Email	JavaMail config, MIME types, Session...	.via(EMAIL)
📱	SMS	Twilio SDK, different API entirely	.via(SMS)
	WhatsApp	Another Twilio setup, prefix logic	.via(WHATSAPP)
	Slack	Webhook HTTP, JSON payload	.via(SLACK)
	Telegram	Bot API, HTTP client setup	.via(TELEGRAM)
	Discord	Webhook HTTP, JSON payload	.via(DISCORD)
👥	Teams	Incoming Webhook, MessageCard JSON	.via(TEAMS)
	Push	Firebase Admin SDK, credentials...	.via(PUSH)
🔗	Webhook	Custom HTTP, payload template	.via(Channel.custom("pagerduty"))
	WebSocket	Java WebSocket API, reconnect logic	.via(WEBSOCKET)
	Google Chat	Webhook HTTP, JSON payload	.via(GOOGLE_CHAT)
	Twitter/X	OAuth 1.0a, API v2 setup	.via(TWITTER)
💼	LinkedIn	OAuth 2.0, REST API setup	.via(LINKEDIN)
	Notion	Integration Token, API setup	.via(NOTION)
	Twitch	OAuth 2.0, Twitch API setup	.via(TWITCH)
	YouTube	YouTube Data API v3 setup	.via(YOUTUBE)
	Instagram	Meta Graph API setup	.via(INSTAGRAM)
📧	SendGrid	SendGrid API, webhook tracking	.via(Channel.custom("sendgrid"))
	TikTok Shop	HMAC-SHA256, Shop API	.via(TIKTOK_SHOP)
	Facebook	Graph API, Page tokens	.via(FACEBOOK)
☁️	AWS SNS	AWS SDK, credentials, ARN	.via(Channel.custom("aws-sns"))
	Mailgun	Mailgun API, domain setup	.via(Channel.custom("mailgun"))
	PagerDuty	Events API v2, routing key	.via(Channel.custom("pagerduty"))
	Kick	Public API, OAuth 2.1	.via(KICK)
	Multiple channels	Completely different code for each	Same fluent API
Fallback	Manual try/catch chain	.fallback(SMS)
Retry	Implement yourself	Built-in exponential backoff
Async	Thread pools, CompletableFuture	.sendAsync()
Scheduling	ScheduledExecutor, timer logic	.schedule(Duration.ofMinutes(30))
Templates	Each channel has its own engine	One template, all channels
i18n	Manual locale resolution	.locale(Locale.PT_BR)
Rate limiting	Token bucket from scratch	Config-driven per-channel
Tracking	Build your own delivery log	Built-in receipts + JPA
Dead letters	Lost in the void	Auto-captured in DLQ
Deduplication	Track sent messages yourself	Built-in content hash / explicit key
Template versions	Manage files manually	.templateVersion("v2") + A/B test
Batch	Loop and pray	.toAll(users).send()
Monitoring	Wire Micrometer yourself	Auto-configured counters
Health checks	Write an Actuator indicator	Auto-configured
Admin UI	Build your own dashboard	Built-in /notify-admin
Circuit breaker	Implement yourself per channel	Built-in per-channel circuit breaker
Orchestration	Manual escalation logic	.orchestrate().first(EMAIL).ifNoOpen(24h).then(PUSH)
A/B testing	External service + glue code	Built-in .abTest("exp").variant(...).split(50,50)
Testing	Mock everything	TestNotifyHub captures all sends
New channel	Build from scratch	Implement one interface

Table of Contents

• Quick Start
• Features
  • Fallback Chain
  • Multi-Channel Send
  • Async Sending
  • Retry with Backoff
  • Templates (Mustache)
  • i18n (Internationalization)
  • Attachments
  • Priority Levels
  • Rate Limiting
  • Dead Letter Queue (DLQ)
  • Batch Send
  • Delivery Tracking
  • Scheduled Notifications
  • Notification Routing
  • Notifiable Interface
  • Message Deduplication
  • Template Versioning
  • Custom Channels
  • Event Listeners + Spring Events
  • Named Recipients
  • Message Queue (RabbitMQ / Kafka)
  • Circuit Breaker
  • Bulkhead (Concurrency Isolation)
  • Multi-Channel Orchestration
  • A/B Testing
  • Cron Scheduling
  • Quiet Hours
  • Testing Utilities
• Supported Channels
• Admin Dashboard
• Spring Boot Integration
• Configuration Reference
• Without Spring Boot
• MCP Server (AI Agents)
• Running the Demo
• Architecture
• Maven Central
• Roadmap
• License

Quick Start

1. Add the dependency

<dependency>
    <groupId>io.github.gabrielbbaldez</groupId>
    <artifactId>notify-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

Need extra channels? Add optional modules:

xml

Copy

<!-- SMS + WhatsApp (Twilio) -->
<dependency>
    <groupId>io.github.gabrielbbaldez</groupId>
    <artifactId>notify-sms</artifactId>
    <version>1.0.0</version>
</dependency>

<!-- Slack / Telegram / Discord / Teams / Firebase Push / Webhook -->
<dependency>
    <groupId>io.github.gabrielbbaldez</groupId>
    <artifactId>notify-slack</artifactId>
    <version>1.0.0</version>
</dependency>

<!-- WebSocket / Google Chat -->
<dependency>
    <groupId>io.github.gabrielbbaldez</groupId>
    <artifactId>notify-websocket</artifactId>
    <version>1.0.0</version>
</dependency>

2. Configure in application.yml

notify:
  channels:
    email:
      host: smtp.gmail.com
      port: 587
      username: ${GMAIL_USER}
      password: ${GMAIL_PASS}
      from: noreply@myapp.com
      from-name: MyApp
      tls: true
  retry:
    max-attempts: 3
    strategy: exponential
  tracking:
    enabled: true

3. Inject and use

@Service
public class OrderService {

    private final NotifyHub notify;

    public OrderService(NotifyHub notify) {
        this.notify = notify;
    }