Common Alerting Protocol (CAP) is an XML-based data format for exchanging public warnings and emergencies between alerting technologies.
Omnilert supports sending messages in CAP format. The CAP endpoint allows alerts to be either posted (via HTTP POST) or retrieved from Omnilert via a CAP feed URL.
Basic CAP configuration settings
The first 3 settings in the CAP configuration determine how messages will be delivered. Omnilert offers both "pull" and "push" options for CAP.
To "pull" messages, much like reading an RSS feed, use the Default CAP retrieval URL.
To "push" messages to your listening server, use the optional Default URL to post to setting. Simply enter your listening server's URL. Omnilert will attempt to post messages to that server.
Note: If using the "post" option, your server must be reachable by Omnilert. This may require adjustments to local firewall settings at your server's location. Please contact email@example.com if you need an IP address or other arrangements to traverse your firewalls.
The CAP retrieval messages setting determines how many CAP alerts Omnilert will keep in your CAP feed for retrieval ("pull").
This can be used to force Omnilert to either stack multiple CAP messages in the feed or just use "Last 1" to force Omnilert to replace any existing message with the most recent CAP alert sent.
Other CAP settings
The CAP endpoint must be configured to include some required fields to meet the CAP standard. The settings used should reflect the needs of your recipient system.
Fields with dropdowns will show the possible values allowed under the CAP standard. Fields with open text areas allow you to enter your own text values.
For more info on the various CAP fields and their meanings and intended uses, see the CAP standard at http://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2-os.html
Example of CAP POST XML Content
Most CAP-based systems will read and use the fields provided with the CAP standard. The following is an example of the fields posted when sending CAP messages via HTTP/HTTPS POST.
As you can see, the Subject and Message content from Omnilert are sent in the <headline> and <description> fields of the CAP formatted XML content sent by Omnilert.