blurblah/notiboy repository overview

⁠notiboy

HTTP API service for the notifications.

notiboy can notify to users through email or slack.

⁠Prerequisites

1. Mailgun api key : Sign-in to Mailgun⁠ and issue a api key

2. Slack oauth access token : Create a slack app through this link⁠ if you don't have it and generate oauth token.

3. Slack app permissions : Should be granted some permissions, channels:read, chat:write:bot and groups:read.

⁠How to build

⁠1. Packaging

mvn clean package

⁠2. Docker image

mvn dockerfile:build

⁠How to run

java -jar notiboy-0.1.jar

⁠How to use APIs

⁠1. Email notification

http://localhost:8080/mail⁠

Method : POST

Request header : Content-Type: application/json

JSON Sample :

{
    "from": "info<[email protected]>",
    "recipients": [
        "[email protected]"
    ],
    "subject": "Hello, notiboy",	
    "content": "Hi"
}

⁠2. Slack notification

http://localhost:8080/slack⁠

Method : POST

Request header : Content-Type: application/json

JSON sample :

{
    "channel": "general",
    "message": "Hello"
}