Getting Started

ALERTWest provides two ways to interact with the application: REST APIs and via an Event Broker. Generally, hosted services should interact with the Event Broker, while external services (such as a browser) should interact with the REST API.

Asynchronous Communication through the Event Broker

The Event Broker is the easiest way to get started with new services quickly. The ALERTWest implementation follows a standard EDA pub/sub model facilitated by AWS EventBridge and defined by AsyncAPI, which makes adding new services as both producers and consumers very easy. For more information, visit the AsyncAPI Section.

Synchronous Communication through REST APIs

For requests that cannot be handled asynchronously, ALERTWest provides REST APIs to access. REST APIs are defined by OpenAPI schemas in the OpenAPI Section.