Add webhooks

This topic shows you how to add a generic webhook from the Webhook Alerts Configuration page.

Prerequisites

  • You have the ROLE_ADMIN role.
  • You have an endpoint URL available outside of Data Quality & Observability Classic that can handle HTTP POST and PUT requests from Data Quality & Observability Classic.

Steps

  1. Sign in to Data Quality & Observability Classic and click Cogwheel icon in the left navigation pane.

  2. Click Admin Console.
  3. Click Alerts from the list, then Alert Webhook Configuration.
  4. The Webhook Alerts Configuration page opens.
  5. Click Add Webhook in the upper-right corner.
  6. The Add Webhook dialog box appears.
  7. Enter the required information.
    FieldDescription
    Webhook Name

    The name you assign to a webhook to help you identify and use it in Data Quality & Observability Classic. This name does not need to match the naming conventions of your systems outside Data Quality & Observability Classic.

    Note Webhook names cannot contain spaces.

    URLThe location where JSON payloads containing alert information are sent.
    Method

    The API request method to the service associated with the URL.

    Select either POST (default) or PUT.

    Authentication Type

    Optional. The method that the service associated with the URL uses to authenticate each API request.

    Note Selecting an authentication type is optional. However, if you select Username/Password, the Username and Password fields are required. Currently, only the Username/Password authentication type is supported.

    Username/Password
    Username
    Username credential to the service associated with the URL.
    Password
    Password credential to the service associated with the URL.
  8. Click Save.
  9. The webhook appears in the table on the Webhook Alerts Configuration page.

What's next?