The new REST API is designed for super-easy integration with an abundance of 3rd party applications. Use HTTP POST with any JSON/XML/text body that holds event details/parameters to submit an event to Enterprise Alert. It is super flexible, and the API does not need a specific format. Instead, you can let your source systems (e.g. VMware, Splunk, OMS, etc.) dictate the format without any alteration or coding.
For each of these systems you create a dedicated new REST event source in the system section of EnterpriseAlert. Authentication can be done through an API key or though HTTP Basic Authentication. More details can be found in our updated Getting Started document.
The REST API ships with OpenAPI (“Swagger”) online documentation and a Swagger UI “API Explorer”. It can be opened directly from the configuration details of a REST source (URL hyperlink) and contains the API description, displays authentication details and allows you to tryout the API from your web browser. As mentioned, the REST API is currently limited to receive events from your 3rd party systems in order to trigger automated alert notifications to responsible targets. However, we want to add further handlers, e.g. for user provisioning or alert retrieval in the mid-future. The REST API is part of the OpenAPI edition or any “higher” edition of EnterpriseAlert.
In our example we are using Swagger to send event data to Enterprise Alert. Policies conditions will be triggers by the incoming parameters and thus alerting the right people at the right time.
If you go back to the Swagger document (should still be in a separate window) and click Try it Out! again this will fire off another instance and this time trigger the alert policy that was just created. Alerts can be viewed in the web portal as well as in the mobile app. Additionally, SMS and Emails can be sent as well.
To apply the REST API to an external source locate the REST API link under Endpoints on the Enterprise Alert web portal’s main screen. Alter this link by replacing ‘key’ with the API key generated from the Event Source.
Notifications within the Enterprise Alert mobile app
Enterprise Alert comes complete with a mobile app allowing for all critical alert details to be seen from anywhere. Users can acknowledge and take ownership of alerts and with remote actions, even resolve them. Team members collaborate with their peers so that even if an on-call person is not the SME, that person is easily within reach via voice call, text or email.
A centralized Alert Center can be viewed from the web portal. All alerts, whether active, overdue or closed are visible to EA admins. Ownership and even delegation is as easy as drag-and-dropping the alert to the person/team.