Use nOps Webhooks integrations to notify you when a specific event, such as a violation, occurs in your AWS cloud environment.

You must be an Admin user to set up a Webhook.

nOps Webhooks are easy to configure, use HTTP protocols, and are extensible. They support the standard GET, POST, PUT, PATCH, and DELETE operators.

This article contains the following topics:

Before you Begin

Configure a Webhook

Pause, Edit, or Delete a Webhook

Before you begin

  1. Login to nOps using an Admin role

  2. From the Profile menu select Organization Settings to go to the Setting pane.

    If you are a partner Admin, From the Profile menu select Manage Clients, select a client from the list, click the dot menu and select Go To This Account > then select Organization Settings from the Profile menu.

  3. From the Settings pane click Integrations.

  4. Select the Outgoing Webhooks tab

What to know before you create an Outgoing Webhook

  • Create outgoing webhooks to notify you about violations as they occur in your AWS environment.

  • Use the +Create Webhook to create as many webhooks as required
    IMPORTANT: All fields marked with an asterisk are required. The webhook cannot be saved without this information.

  • We currently support the following Event Type and Request Methods.

    Note: The dialog choices change when a different Request Method is selected.

For Event Type

Select this Request Method

Triggered

New Rule Violation

POST

Anytime a new rule violation occurs.

Configure a Webhook

  1. From the Integrations page select the Outgoing Webhooks tab.

  2. Click the +Create Webhook button.

  3. At the Create New Webhook dialog enter a Name for the webhook.

  4. The Event Type field is set to allow a New Rule Violation notification event type.

  5. The Request Method field contains GET, POST, PUT, PATCH and DELETE operators.
    To send information about the rule violation, select POST.

  6. Enter the End Point (Target URL) information. An end point is the URL for where the notification will appear. Most customers typically post to a specific Slack channel. You will need to get this URL from the target application. For example, for Slack see the link on how to get started with incoming Slack Webhooks.

  7. Once the webhook is created, the target app will provide information about the Header key and value pair. For example, for Slack the header and value pair are:

    Content-type and application/json

    You can add multiple Headers if required.

  8. The Substitutions table displays the attributes that you can use in the Request Body for information about the violation. For the New Rule Violation event type your choices are:
    {{time}} The time the event was detected

    {{name}} The name of the rule that was violated

    {{description}} Details about the rule.

  9. The Request Body contains an automatic JSON validator to check the code.
    Add or edit the text attribute to send a specific message as seen in the following example:

    {
    text: 'nOps detected another New rule violation. The rule {{name}} was violated at: {{time}}. Description {{description}}.'
    }

  10. Click Save to save the webhook.

Pause, Edit, or Delete a Webhook

Once a webhook is created, you can pause it, edit it, or delete it from the list on the Outgoing Webhooks tab.

  • Turn the toggle off to pause the webhook. The webhook will not work until the toggle is enabled.

  • Click the Edit icon to edit a webhook. For example if you need to change the enpoint location

  • Delete the webhook using the Trash icon.
    Note: Once the webhook is deleted the information cannot be recovered.

Did this answer your question?