We have introduced a new version of the Command Alert API. There is now an “API generator” utility that can export the Alert in a format that can be tested and imported into an Emergency Management Provider.

Using the Export Utility

1. Select Alert

2. Build the Alert

1. Select the Device Group

2. (optional) Select the Alert sound - select duration option; if custom duration is selected, enter the number of seconds the audio file should play

3. Select the Alert Image

3. Select API Generator to export a .JSON file. Save the file to your computer

4. Open Postman

1. Select Import Project, locate the .JSON file on your computer, and select Open.

2. After importing, we recommend renaming the Collection according to the Device Group and Alert. For example, “RedOakEL_Hold”

5. Navigate the Alert within Postman to test as needed. Each POST will have the following elements

1. URL - this URL calls to the Command server to activate the Alert.

2. Headers - These provide unique keys to keep this action secure from malicious users

3. Body - This is pulled from Command and is the main content of the Alert.

6. Test the Alert from within Postman (as needed)

1. Within Postman, select Send Alert With Device Groups and select the “Send” button to open the alert. !!!Caution!!! This sends the alert to a defined group of panels.

2. Within Postman, select Cancel Alert to Groups and select the “Send” button to close the alert. !!!Caution!!! This cancels the alert to a defined group of panels.

7. Copy and paste each element from Postman into your Emergency Alert Provider web console.
   

Disabling the API

If it becomes necessary to disable the API, please take the following steps

1. Hover over the drop arrow next to API generator and select the Generate records button.

2. Select “Disable API” to disable all previously generated API scripts