Eventhos is an open source platform that applies event-driven architecture principles to allow the user to orchestrate their system integrations using a simple user interface instead of complicated publisher and subscriber source codes in applications. You only need webhooks and rest APIs to integrate all your systems.
Full details in the wiki
Basically you have to identify the producers (webhooks) and consumers (apis). Then using th UI you can make a contract between the incoming event produced by a webhook (source system) to the rest api in in the target system. So with this you will have a real time integration between the producer and consumer systems without the complexity of kafka or similars.
Here a sample of contract between producers and consumers
create-contract-2024-04-05_17.50.51.mp4
More uses cases and deep explanation here and here
- Register all systems (producers and consumers)
- Create contracts between your systems
- Oauth2 Security
- Manual retry on error
- Event Dashboard to see the received events and all the details (request/response)
- Reply-To option
- Json binding to match between the webhook json and target api json
- Vanilla javascript to binding to match between the webhook json and target api json
- Mail on error with the details
- User Management
More details here
Here a minimalist High Level Diagram
To know more about each dependency check their git repositories.
In this repository you will find the code of the web artifact called eventhos-api. You will need the api to get all the eventhos platform ready to use or develop
To build and start this platform you need knowledge about nodejs and mysql. To get your own version in less than 3 minutes, follow this guide:
If you don't have errors, you will be able to perform a get request to http://localhost:2109. You should see ok as response.
- Nodejs
- Knex
- Mysql
- nodejs >= 16
- mysql >= 5.5 (user with all privileges)
Following the third commandment we use environment variables to handle the configurations
| Variable | Description | Sample Value |
|---|---|---|
| CPU_COUNT | How many cpu cores use | 1 |
| CRYPTO_KEY | The secret key to encrypt | secret_key |
| DATA_BASE_ACQUIRE_CONNECTION_TIMEOUT | The timeout to acquire a connection using knex | 10000 |
| DATA_BASE_HOST | The eventhos platform database host | localhost |
| DATA_BASE_NAME | The eventhos platform database name | eventhos |
| DATA_BASE_PASSWORD | The eventhos platform database password | abcdefg |
| DATA_BASE_POOL_MAX | The maximum knex connection pool | 300 |
| DATA_BASE_POOL_MIN | The minimum knex connection pool | 100 |
| DATA_BASE_PORT | The eventhos platform database port | 3306 |
| DATA_BASE_TIMEZONE | Required to sync the datetime in mysql2 nodejs library | +00:00 |
| DATA_BASE_USER | The eventhos platform database user | usr_eventhos |
| ENVIRONMENT_ALIAS | Used in the subject on email error report, example: dev,prod,et. | Test |
| HTTP_BODY_SIZE_LIMIT | Supported size of the json that interacts with the app | 50mb |
| JWT_SECRET | The secret for the JWT | secret |
| LOG_FILE_PATH | Use a file for the logs | false |
| LOG_LEVEL | Set the logger level | debug |
| PORT | The application port | 2109 |
| RAW_SENSIBLE_PARAMS | Word to be obfuscated in mails and ui | credit_card, address |
| SMTP_CREDENTIAL_PASSWORD | Password of your mail server | changeme |
| SMTP_CREDENTIAL_USER | User of your mail server | noreply@acme.com |
| SMTP_DEFAULT_RECIPIENT | Default recipients if there aren't recipients in a contract or if there are error before event's send | jane@acme.com |
| SMTP_ENABLE_SSL | Encrypt. If your host is for gmail, your value should be true. If your host is for office 365, your value should be false |
true |
| SMTP_FROM_ALIAS | Should be able equal to the value of SMTP_CREDENTIAL_USER | noreply@acme.com or custom if your smtp allow it |
| SMTP_HOST | Sender identifier | smtp.gmail.com |
| SMTP_PORT | Communication endpoint that defines the routing of email transactions | 587 |
| SMTP_TLS_CIPHERS | Are algorithms that help secure network connections that use Transport Layer Security | SSLv3 |
| TZ | Os timezone | America/Lima |
To use these variables in your developer workspace, check this
Authentication and authorization are based on a custom oauth2 implementation oauth2-starter library.
This library will create a credentials.txt file with the admin credentiaLS in the /tmp folder.
📢 Change it after the first login
Just run docker-compose up -d
Export the required env variables or create a .env
npm install
npm run devBy default the app runs in the 2109 port.
Export the required env variables or create a .env
npm install
npm run build
npm run startBy default the app runs in the 2109 port.
Also you can use docker following this guide
For correct easy operation, the ui is required.
Once the application is running you can either use the eventhos UI (recommended) or use the rest endpoints whic are documented here in the section Endpoints
Keeping in mind that software should be reused, we have developed the following libraries to build eventhos-api
| name | url | branch | description |
|---|---|---|---|
| advanced-settings | https://github.com/nodeboot/advanced-settings | main | use env variables in the json settings |
| nodeboot-oauth2-starter | https://github.com/usil/nodeboot-oauth2-starter#fix-validator-middleware | 1.0.1 | oauth2 autonconfigure database and endpoints |
If you startup the local demo you can run the integration and e2e tests.
We use docker, selenium and a mock api to test almost all the ui forms and rest api endpoints. Check this for more details:
Check this https://github.com/usil/eventhos-api/wiki/Contributions
Luis Huertas |
JRichardsz |
Diego Ramos |