In addition to sending standard alert emails to your alarm recipient groups, CloudReady let’s you create alarm web hooks as well. A web hook will send an HTTPS (https/TLS is required) post request to the URL you choose, so that you can integrate your CloudReady alerts with with other systems. More information about web hooks can be found here: https://en.wikipedia.org/wiki/Webhook
How To Configure
Navigate to Alarms > Settings > Web Hooks from within CloudReady. From there, you can click ‘Add’ to create a new web hook. Provide a name and a target URL, and then choose what kind of authorization you would like to use and specify any custom headers you need.
Web Hook Elements
Give each web hook a unique name, typically that indicates where the notifications are sent
- Target URL
Web hooks are sent to a destination URL. CloudReady web hooks requires HTTPS connections
- JSON Escape Content
If JSON is included for the templates it can optionally be escaped and this depends on how it is being consumed or processed
- Enable Basic Authorization
Many web hooks utilize basic authorization. Check this box and supply the credentials if your web hook requires it
- Custom Headers
Web hook implementations often rely on headers. Supply them here
- Enable Ring Event
Alarms are rung and resolved, if the alarm generation is desired then check this box.
See Template Body below
- Enable Resolved Event
When the alarm condition is resolved the web hook cban be notified if this is checked. Optional Ring and Resolved Events enable flexible handling to separate web hooks.
When an alarm is generated, or the alarm rings, it will use the template body to send, in a POST, to the web hooks destination URL. Each event generation, ring or resolved, has a separate template for the configuration. The template is a body of text that will be sent to the web hook’s target URL after substitution. Read more about alarm hook templates and variable substitution.