barpaw/matrix-notifier-ee2e-api repository overview

⁠matrix-notifier-ee2e-api

API for sending messages in encrypted rooms (matrix)

⁠About

This project allows you to send messages in encrypted matrix rooms using a web api.

⁠Endpoints

Send message to ee2e matrix room

• POST /send-message

curl -X 'POST' \
  'http://localhost:8001/send-message' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "matrixHomeserverURL": "string",
  "matrixHomeserverUser": "string",
  "matrixHomeserverPasswd": "string",
  "matrixHomeserverRoom": "string",
  "message": "string"
}

Healthcheck

• GET /health

Swagger

• GET /docs

Redoc

• GET /redoc

⁠Usage

• Create a matrix user then join the room where you want to send messages and logout

• docker run -d --rm -p 8001:8001 barpaw/matrix-notifier-ee2e-api:0.0.1

• Try it http://localhost:8001/docs⁠

⁠Dependecies

• Docker

⁠Project python packages

• matrix-nio[e2e]⁠
• FastAPI⁠
• pydantic⁠
• uvicorn⁠

⁠Docker Hub

barpaw/matrix-notifier-ee2e-api⁠