Creating Generic Webhook connections

If you want to connect to a data source and a dedicated connection is not available for that source in the IBM Cloud Pak for Watson AIOps Data and tools connection UI, you can use the generic webhook connection. This connection provides an endpoint for applications to send JSON formatted events to IBM Cloud Pak for Watson AIOps through HTTP POST requests.

In the requests you can also include JSONata that maps incoming JSON payloads to IBM Cloud Pak for Watson AIOps events.

Limitation: Limitation: A generic webhook endpoint is limited to only one incoming JSON payload structure. The generic webhook connector does not support connections with JSON arrays. A connection to Prometheus or Microsoft Azure does not work with a generic webhook connection to IBM Cloud Pak for Watson AIOps.

For more information about working with a generic webhook connections, see the following sections:

Before you begin

To configure a generic webhook connection, you need the following information for the application that you are connecting to IBM Cloud Pak for Watson AIOps:

  • A name and description for the webhook connection.
  • If you need to secure the webhook, the appropriate user name and password.
  • The JSONata that maps the incoming JSON payload to IBM Cloud Pak for Watson AIOps events.

Creating a Generic Webhook connection

To create a Generic Webhook connection, complete the following steps:

  1. Log in to IBM Cloud Pak Automation console.

  2. Expand the navigation menu (four horizontal bars), then click Define > Data and tool connections.

  3. On the Data and tool connections page, click Add connection.

  4. From the list of available connections, find and click the Generic Webhook tile.

    Note: If you do not immediately see the connection that you want to create, you can filter the tiles by type of connection. Click the type of connection that you want in the Category section (Events).

  5. On the side-panel, review the instructions and when ready to continue, click Connect.

  6. On the Add connection page, define the general connection details:

    • Name: The display name of your connection.

    • Description: An optional description for the connection.

    • Authentication type: Select the Username/Password or None option.

    • Username: Enter the appropriate username to authenticate the connection.

    • Password: Enter the appropriate password to authenticate the connection.

    • Webhook route: The predefined full URL (location) of the webhook. This field is not editable.

      Enabling or disabling a Generic Webhook connection

      After you create your webhook connection, you can enable or disable the webhook by completing the following steps:

      1. Log in to IBM Cloud Pak Automation console.

      2. Expand the navigation menu (four horizontal bars), then click Define > Data and tool connections.

      3. Click the Generic Webhook connection type on the Manage connections tab of the Data and tool connections page.

      4. On the Generic Webhook page, click the name of the connection that you want to edit. Alternatively, you can click the options menu (three vertical dots) for the connection and click Edit. The connection configuration opens.

      5. Enable or disable the webhook by clicking the toggle to change the setting to Enable webhook or Disable webhook. When disabled, the webhook connector discards incoming HTTP requests.

      6. Click Save when you are done.

      Your webhook is now enabled or disabled.

      Editing a Generic Webhook connection

      After you create your connection, you can edit the connection. For example, if you want to add or change the listed GUI or backend URLs for the IBM Tivoli Netcool/Impact endpoint, or to update the User ID or password. To edit a connection, complete the following steps:

      1. Log in to IBM Cloud Pak Automation console.

      2. Expand the navigation menu (four horizontal bars), then click Define > Data and tool connections.

      3. Click the Generic Webhook connection type on the Manage connections tab of the Data and tool connections page.

      4. On the Generic Webhook page, click the name of the connection that you want to edit. Alternatively, you can click the options menu (three vertical dots) for the connection and click Edit. The connection configuration opens.

      5. Edit your connection as required. Click Save when you are done editing.

      Your connection is now edited.

      Deleting a Generic Webhook connection

      If you no longer need your connection and want to delete it entirely, you can delete the connection from the console.

      To delete a connection, complete the following steps:

      1. Log in to IBM Cloud Pak Automation console.

      2. Expand the navigation menu (four horizontal bars), then click Define > Data and tool connections.

      3. Click the Generic Webhook connection type on the Manage connections tab of the Data and tool connections page.

      4. On the Generic Webhook connections page, click the Delete icon for the connection that you want to delete.

      5. Enter the name of the connection to confirm that you want to delete your connection. Then, click Delete.

      Your connection is deleted.