webhook-listener

Service to listen for webhooks, save them to redis, provide UI and API.

Example

UI and Swagger

Start

# start redis container
    docker run --name my-redis -p 6379:6379 -d redis

# start service
    make start

# start webpage
    make web-dev

Swagger will be available at localhost:8080/swagger/
Websockets url: ws://localhost:8080/listen/{channel}
Webpage url: localhost:8080/

How it works

• accepts http post requests to https://webhook.shelex.dev/api/{channel}
• publish message to redis pubsub "webhooks" channel
• notification module read messages by webhooks subscription and send them via websockets to subscribers
• repository module read messages by webhooks subscription and store them in redis
• api endpoints available for get and delete operations for messages stored in redis for specific channel
• websocket subscription option available to check incoming messages
• every 3rd hour at 0 minute cron task checks storage and clears messages older than 3 days

How to set up VPS

Ubuntu 22 is used.

Connect to ssh

IP address 111.111.111.11 as an example.

    ssh -i {{path_to_ssh_keys}} [email protected]

Install deps

•     sudo apt update

• redis: https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-ubuntu-22-04
• nginx: https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-22-04

Prepare web and go builds

Pre-requisite: prepare .env and web/.env config files with proper values.

    make web-build
    make build

Upload to vps

    scp -r ./web/build/* [email protected]:/var/www/webhook.shelex.dev/html/
    scp ./bin/* [email protected]:/usr/bin
    scp .env [email protected]:/usr/bin

Handle backend service with systemd

• create service file:

    nano /etc/systemd/system/webhook-listener.service

• paste content from configs/webhook-listener.service

• reload daemon, start service, check status

    systemctl daemon-reload
    service webhook-listener start
    service webhook-listener status

Basic setup for nginx and certbot

• https://www.nginx.com/blog/using-free-ssltls-certificates-from-lets-encrypt-with-nginx/
• sudo certbot --nginx -d webhook.shelex.dev -d www.webhook.shelex.dev

Configure nginx

• create nginx config:

   sudo nano /etc/nginx/sites-enabled/webhook.shelex.dev

• paste content from configs/webhook.shelex.dev
• remove default site from /etc/nginx/sites-available
• make sure ports are not conflicting with apache (sudo update-rc.d apache2 disable)