SreemanthG/webhooks-microservice-dyte

A Webhooks Microservice using Node and Moleculer

Webhooks Microservice

A Webhooks Microservice using Node and Moleculer

📖 Table of Contents

Table of Contents

1. ➤ About The Project
2. ➤ Features
3. ➤ Folder Structure
4. ➤ Running Locally
5. ➤ RESTful URLs
6. ➤Requests and Responses
7. ➤ Feedback

📝 About The Project

This is a Webhook Microservice project. Moleculer, a microservices framework, was used to create this microservice. The goal of this project is to create an API that allows many webhooks to be invoked at the same time.

🍴 Features

The following are the features provided by this microservice:

• Registers new target URL's into system
• Lists out all the target URL's
• Updates the specific target URL
• Invokes all the target URL's parallely

🌵 Folder Structure

└── webhooks-microservice-dyte/
    ├── data/
    │   └── webhooks.db
    ├── mixins/
    │   └── db.mixin.js
    ├── public/
    │   └── index.html
    ├── services/
    │   ├── api-service.js
    │   └── webhooks.service.js
    ├── utils/
    │   └── sendRequest.js
    ├── .dockerignore
    ├── .editorconfig
    ├── .eslintrc.js
    ├── .gitignore
    ├── docker-compose.env
    ├── docker-compose.yml
    ├── Dockerfile
    ├── k8s.yaml
    ├── moleculer.config.js
    ├── package-lock.json
    ├── package.json
    └── README.md

💾 Running Locally

Make sure you have NodeJS and the Mongodb installed.

git clone https://github.com/SreemanthG/webhooks-microservice-dyte.git

cd webhooks-microservice-dyte

npm install

Development

npm run dev

Production

npm run start

Docker

docker-compose up

🎯 RESTful URLs

Good URL examples

• Registering a target URL:
  • POST http://localhost:3000/api/webhooks/register
• Listing out target URL's:
  • POST http://localhost:3000/api/webhooks/list
• Updating a target URL:
  • PUT http://localhost:3000/api/webhooks/update/:id
• Trigerring all the target URL's:
  • GET http://localhost:3000/api/webhooks/ip

Bad URL examples

• Registering a target URL:
  • GET http://localhost:3000/api/webhooks/register
• Listing out target URL's:
  • POST http://localhost:3000/list
• Updating a target URL:
  • PUT http://localhost:3000/api/webhooks/update/
• Trigerring all the target URL's:
  • GET http://localhost:3000/api/webhooks/trigger

🔨 Requests and Responses

API Resources

• POST /register
• POST /list
• PUT /update/:id
• GET /ip

POST /register

Example: http://localhost:3000/api/webhooks/register

Request body(JSON):

  {
  
    "targetUrl":"http://www.google.com"
  
  }

Response body:

  {
    "_id": "iEKJVNnLPYGwPvVk"
  }

POST /list

Example: http://localhost:3000/api/webhooks/register

Request body(JSON):

  {}

Response body:

  {
    "rows": [
        {
            "_id": "iEKJVNnLPYGwPvVk",
            "targetUrl": "http://www.google.com/"
        }
    ]
    "total": 1,
    "page": 1,
    "pageSize": 10,
    "totalPages": 1
  }

PUT /update/:id

Example: http://localhost:3000/api/webhooks/update/JAP611ZUF0yaVaLt

Request body(JSON):

  {
    "newTargetUrl":"http://www.youtube.com"
  }

Response body:

  {
    "_id": "JAP611ZUF0yaVaLt",
    "targetUrl": "http://www.google.com/"
  }

GET /ip

Example: http://localhost:3000/api/webhooks/ip

Request body(JSON):

  {
    "ipAddress":"198.168.0.1"
  }

Response body:

  [
    {
        "targetUrl": "http://www.google.com/",
        "_id": "JAP611ZUF0yaVaLt",
        "status": 201,
        "retries": 0
    }
  ]

💠 Feedback

Feel free to send feedback on [Twitter](https://twitter.com/GSreemanth) or [file an issue](https://github.com/SreemanthG/webhooks-microservice-dyte/issues/new). Feature requests are always welcome. You can contact me at sreemanth2001@gmail.com