Skip to main content
Skip table of contents

Generic Webhook Configuration For Pushing Incidents To Cloudaware

Cloudaware integrates with monitoring services such as Pingdom, Sumo Logic, Zabbix, etc. These services collect and analyze data from various resources (for example, AWS S3 buckets, CloudTrail, or URLs) and can send notifications or alerts about the current state of a resource.

By using a webhook integration, this information can be forwarded to Cloudaware Incidents. To enable this feature, generate a webhook URL in the monitoring service and configure it as the destination for incident data.

Introduction

CloudAware Incident is a Cloudaware-managed object with fields such as Incident Source Provider, Duration, Severity, etc. to store data received from customer integrations:

Generic Webhook Configuration For Incidents - schema.png

If fields are not populated, possible reasons include:

  • No issues were detected

  • Misconfiguration

Create an API Key

The key is required to authenticate requests to the Cloudaware API. 

Prerequisites

Once access is granted by Cloudaware, generate an API key:

  1. Log in to the Google Cloud Console. Navigate to APIs & ServicesLibrary.

  2. Filter APIs by Private:

    Generic webhook for incidents - Create an API Key - private APIs.png

     

  3. Locate and select external.endpoints.cloudaware-vm.cloud.goog Enable.

    Generic webhook for incidents - Create an API Key - enable API.png

     

  4. Go back to APIs & Services. Select Credentials → click +CREATE CREDENTIALS → API Key.

    Generic webhook for incidents - Create an API Key - create API key.png

     

  5. Copy the API Key to the clipboard.

Configure Incident Webhook in Cloudaware

  1. Log in to Cloudaware → Admin.

    Generic webhook for incidents - configure Incident Webhook - admin.png

     

  2. Find CloudAware Incident Webhook in Other integrations. Click +ADD.

    Generic webhook for incidents - configure Incident Webhook - admin - add integration.png

     

  3. Set a name* for this integration. 

    Generic webhook for incidents - configure Incident Webhook - integration details.png

*This name appears in the ‘Incident Source Provider’ field on the CloudAware Incident object. Use it to distinguish between incidents from different providers or accounts.

 

  1. Replace {API_KEY} in the URL with your actual API Key (see step 5 above). Use this updated URL to send HTTP requests.

    Generic webhook for incidents - configure Incident Webhook - integration URL.png

Set up a request in APIs Explorer

The Google APIs Explorer is a tool to explore and test APIs. Set the request details to create a test incident in Cloudaware.

 

  1. Open the Google APIs Explorer.

  2. Click the gear icon → select Set API key / OAuth 2.0 Client ID. 

    Generic webhook for incidents - set up a request in APIs Explorer - select Set API key OAuth 2.0 Client ID.png

     

  3. Select Custom credentials and paste your API key. Click Save.

    Generic webhook for incidents - set up a request in APIs Explorer - paste API key in Custom credentials.png

     

  4. Navigate to Services External API → external.incidents.create.

    Generic webhook for incidents - set up a request in APIs Explorer - select External API for incidents.png

  5. Enter the required parameters. Use the help icons (?) next to each field to get tips and field descriptions.

    Generic webhook for incidents - set up a request in APIs Explorer - set fields in a body.png

     

  6. Choose Authorize and execute or Execute without OAuth, depending on your API method.

  7. Verify that a new incident appears in the Cloudaware CMDB.

    Generic Webhook Configuration For Incidents - incident in CMDB.png
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.