Configure the webhook in Opsview

Configure webhook endpoints so that Opsview can use the endpoint to communicate with Incident Response.

Before you begin

Role required: Responder, Manager, or Administrator

About this task

Note: While this integration with a third-party product is supported, the documentation here is based upon information provided by that third-party. More current information about the operation of that third-party’s system may be available from them directly.

Procedure

  1. Login in to the server where Opsview is deployed.
    1. Place the script file notify_by_webhook.py in the directory /opt/opsview/monitoringscripts/notifications/.
    2. Save the changes by saving the script file as notify_by_webhook.
    3. Make the script executable.
  2. Open your Opsview Web UI.
  3. Under the Configuration tab, click Variables, and click Add New.
  4. In the form, fill in the fields:
    Field Description
    Name Enter LIGHSTEP_INTEGRATION.
    Default Value Enter Lighstep Integration.
    Label Arg 1 Enter Webhook URL.
    Default Arg1 Webhook URL copied from Incident Response.
    New configuration variable.
  5. Click Submit Changes.
  6. Navigate to Configuration tab > Notification Methods.
  7. Click Add New to add a new notification method.
  8. In the form fill in the fields:
    Field Description
    Name Name for the method.
    Enable Select the check box.
    Command Enter notify_by_webhook -w "%LIGHTSTEP_INTEGRATION:1%".
    New notification method.
  9. Click Submit Changes.
  10. Users must select this notification method in the Alert me by field in one of their notification profiles or in the shared notification profiles.
    1. Open an existing notification profile or create a new by clicking Add New.
    2. Select all the alerts types that you want to be alerted on and set the configurations for fields like Role, Users, Re-notification interval, and so on.
    3. In the Alert me by field, select the notification method created for Incident Response.
    4. Click Submit Changes.

    Update notification profile.

    For detailed information, see Notification Profiles.

  11. Navigate to Configuration tab > Users and Roles.
    1. Edit the user for which you want to apply this notification.
    2. Under the Notifications tab, select the notification profile configured for Incident Response.
    3. Click Submit Changes.

    Add the notification profile to the user.

  12. Ensure that the states that you want to be notified on are also enabled in Host and Service checks.

    Hosts

    1. Navigate to Monitoring > Navigator.
    2. Click the hamburger icon for the host that you want to configure the notifications for. Click Edit configuration for Host.
    3. In the edit dialog box, select the Notifications tab.
    4. Select the states that you want to be notified on, notification period (must be the same as the one selected while configuring the notification profile).
    5. Enable Flap Detection.
    6. Click Submit changes.

    Host notification.

    Service checks

    1. Navigate to Configuration > Service checks.
    2. Edit the service check.
    3. Under the Advanced section, make sure all the states you want to be notified on are selected.
    4. Set the Notification Period as Inherit from Host.
    5. Enable Flap Detection.
    6. Click Submit changes.

    Service checks.

  13. Navigate to Configuration > Apply Changes, and click Apply Changes to make the new setup live.
  14. Optional: To test the webhook, navigate to Configuration tab > Notification Methods > Test tab.
    Enter a message and click Send. You will receive an alert with OK severity in Incident Response.

    Test the webhook.