kaushalvivek / notification-microservice

A highly scalable microservice to handle WhatsApp, SMS and email-based notifications.

Notification Microservice

Introduction

This project is a highly scalable micro-service to handle all the notifications (Email/SMS/WhatsApp) that you would require to schedule for contact from your small-business. It uses Amazon's SQS queuing service, SendGrid's email API and Twilio WhatsApp and SMS API to schedule notifications. Support would be added for other service-providers as the project evolves.

Features

• Simple/Bulk WhatsApp notification through a single API call.
• Simple/Bulk SMS notification through a single API call.
• Simple/Bulk rich text Email through a single API call.
• Rate limiter for streamlining bulk notification requests.

QuickStart

• Setup SendGrid and generate an API key
• Setup Twilio, register a number, generate API key and setup SMS and WhatsApp.
• Setup SQS
• Install Docker
• Clone this project

git clone https://github.com/kaushalvivek/notification-microservice.git
cd notification-microservice

• Create environment file

vim .env

Provide all the values as specified in sample_env.sh

• Start the micro-service

sudo docker-compose up -d

Usage

Sending Emails

POST request to : host:PORT/api/v1/notify/email
Request body:

{
    "data":[
        {
            "content":{
                "subject" : "Sample Email's Subject",
                "html" : "<p> Sample email's body</p>"
            },
            "targets":[
                "[email protected]",
                "[email protected]"
            ]
        }
         {
            "content":{
                "subject" : "Sample Email 2's Subject",
                "html" : "<p> Sample email 2's body</p>"
            },
            "targets":[
                "[email protected]"
            ]
        }
    ]
}

Sending WhatsApp messages

POST request to : host:PORT/api/v1/notify/whatsapp
Request body:

{
    "data":[
        {
            "content":{
                "body" : "This is a sample message!"
            },
            "targets":[
                {
                    "countryCode":"+1",
                    "phone":"123456789"
                },
                {
                    "countryCode":"+91",
                    "phone":"9876543211"
                }
            ]
        }
        {
            "content":{
                "body" : "This is another sample message!"
            },
            "targets":[
                {
                    "countryCode":"+1",
                    "phone":"123456789"
                }
            ]
        }
    ]
}

Sending SMS

POST request to : host:PORT/api/v1/notify/sms
Request body:

{
    "data":[
        {
            "content":{
                "body" : "This is a sample message!"
            },
            "targets":[
                {
                    "countryCode":"+1",
                    "phone":"123456789"
                },
                {
                    "countryCode":"+91",
                    "phone":"9876543211"
                }
            ]
        }
        {
            "content":{
                "body" : "This is another sample message!"
            },
            "targets":[
                {
                    "countryCode":"+1",
                    "phone":"123456789"
                }
            ]
        }
    ]
}

Contributing

Feel free to create issues in this repository for contribution. Contributions guidelines would evolve along with the project. Tests for integration would be added soon.

License

MIT License

Copyright (c) 2021 Vivek Kaushal

notification-microservice's Issues

Add tests

Add unit and integration tests for both API and Consumer. Additionally, setup GitHub tests upon merge to main.

Splitted messages before pushing into AWS-SQS

@kaushalvivek Why before pushing the messages into SQS, it's splitted into groups of 10?

exports.queueMessages = async function (messages, queueUrl) {
  try {
    const splittedArray = splitArray(messages, 10) **/// WHY ??**
    for (const arr of splittedArray) {
      const params = {
        QueueUrl: queueUrl,
        Entries: []
      }
      arr.forEach(message => {
        params.Entries.push({
          Id: uuid.v4(),
          MessageBody: JSON.stringify(message)
        })
      })
      await sqs.sendMessageBatch(params).promise()
    };
    return (201)
  } catch (e) {
    throw new Error(e.message)
  }