Skip to content
Luis Huertas edited this page Feb 7, 2022 · 1 revision

Usage

Usage For Development

First run npm install. To start development run npm run dev:start.

Usage For Production

For production you should build your app npm run build will create a dist file. Then run npm start.

General usage

Once the application is running you can either use the eventhos platform (recommended) or use the endpoints that this api has.

Basic workflow

First using the /auth/client endpoint to crate a client. Check the oauth2-starter library to know all of the authentication endpoints.

To use eventhos first you should create a system then create an event for this system, after that create other system but for this one create an action. To link the event with the action create a contract.

Finally make someone use the /event?access-key=<client-token>&event-identifier=<event-identifier> endpoint to call an event that will trigger one or more contracts those contract will make some actions happen.

To know more about system, event and contract take a look at the full documentation.

Eventhos

Configurations

Deployment

Usage

Endpoints

Send event

Oauth2

For UI

  • get all events
    • GET /event
  • create events
    • POST /event
  • update events
    • PUT /event
  • delete event
    • DELETE /event
  • get all received events
  • get details of received event
    • GET /event/received/:id
  • get details of executed contracts
    • GET /received/execution-detail/:id
  • create system

Queue Manager

Mail notifications

Ports

Contributions

CDN

Clone this wiki locally