Configuring the probe's HTTP client component

The IBM Tivoli Netcool/OMNIbus Message Bus Probe for Webhook Integrations can be configured to integrate with event sources which support REST API while also acting as a HTTP server to listen to HTTP notifications via the webhook URL. The probe can use REST API to pull data (or re-synchronize events) by sending HTTP requests.

Configuring the probe to perform an initial resync

To configure the probe to send HTTP requests, use the following steps :

  1. Set the probe.host and probe.port with the target server IP or hostname and the port number. For HTTP, it is usually port 80 and 443 for TLS enabled servers.
  2. Set the probe.initialResync parameter to true to configure the probe to perform a re-synchronization during startup. The probe will create a HTTP request using the parameters configured by webhook.resyncRequest.uri , webhook.resyncRequest.method, webhook.resyncRequest.headers and webhook.resyncRequest.content.
  3. Optionally, set the probe.resyncInterval parameter to a number greater than 0 (seconds) to set the re-synchronization interval.
  4. Configure the webhook.resyncRequest.* parameters as follows:
    Table 1. Configurable parameters for the HTTP server

    Parameter name

    Value

    webhook.resyncRequest.uri

    The URI that the probe uses to pull (resync) data.

    For example: /api/alarms/active

    webhook.resyncRequest.method

    The HTTP method for the resync request.

    Set to POST or any of the supported REST API methods supported by the target server.

    webhook.resyncRequest.headers

    (Optional) A comma-separated list of HTTP header options for resync request. This overrides any header set in webhook.httpHeaders.

    For example, to use Bearer token authentication is this request, set this parameter to:

    Authorization=Bearer <your token>

    webhook.resyncRequest.content

    (Optional) The HTTP body to send in the resync request.

    For example, to send a JSON body, set this parameter to:

    {\"severities\":[\"minor\",\"major\",\"critical\",\"clear\"]}
    Note: When using the ICP UI, if any of the parameter values use quote character see Escaping quotes when performing a UI installation
  5. For SSL enabled servers, the probe needs the server certificate in order to send a HTTPS request. This server certificate must be put into a Secret along with a Keystore password. See Enabling a secured connection with a TLS enabled event source.
  6. (Optional) You can configure other request parameters in addition to the webhook.resyncRequest.* parameters to perform other REST API calls to the target server. For more details about the configurable parameters available, see Configurable parameters.