1. Home
  2. Alarms
  3. Alarm Web Hooks

Alarm Web Hooks

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

  • Name
    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
  • Request method
    Select either POST or GET as the request method.
  • Content Type
    Choose either JSON or plain text. JSON must be valid.
  • 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. Use the format Header-Name: Header-Value and put one header per line
  • Enable Ring Event
    Alarms are rung and resolved, if the alarm generation is desired then check this box.
  • 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.
  • Message Body
    See Message Body below. Both the alarm ring event and alarm resolve event can be enabled and can have their own message bodies.

Message Bodies

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.

Troubleshooting

If a webhook returns an error, the two most likely causes are authorization or formatting. Make sure that any credentials or other authorization or authentication information provided is correct. Also make sure that the message bodies are in the format required. Some endpoints require specific formatting, some just require valid JSON. JSON validation tools are useful to ensure the message body is correct. Sending a test request to your endpoint is also useful, this can be done by clicking on the gear icon in the edit column and then clicking ‘Send Test’.

Related Articles