Forwarding notifications to external applications

You can configure IBM Software Hub to forward notifications that are generated by services to external applications, such as JIRA and IBM Business Automation Workflow

Before you begin

This feature is available only if you installed a service with a dependency on the IBM Software Hub common core services.

About this task

A target is an external application that has a webhook that accepts incoming HTTP requests. You can configure multiple targets if you want to forward information about different events to different applications.

Procedure

  1. Log in to the web client.
  2. From the navigation menu, select Administration > Configurations and settings.
  3. Click Notification forwarding.
  4. Click New target.
  5. Specify a name and description for the target.
  6. Choose External application. Then, click Create.
  7. On the Events tab, click Add events and select the type of event or events that you want to forward notifications for. Then, click Add.
    You can forward notifications for:
    • Changes to assets in a catalog
    • Changes to data quality SLA violation information in a catalog
    • Changes to data quality SLA assessments in a catalog
    • Changes to assets in a project
    • Changes to data quality SLA violation information in a project
    • Changes to data quality SLA assessments in a project
    • Changes to projects
    • Changes to project members
    • Changes to jobs
    • Changes to job runs
    • Changes to data quality
    • Changes to governance artifacts
    • Changes to metadata imports
  8. By default, all of the events in all workspaces trigger notification forwarding. However, you can specify the criteria under which you want the notifications to be forwarded. Click the Edit icon icon to change the relevant criteria.
    If you modify the criteria, keep the following restrictions in mind:
    • For some criteria, you cannot revert to the event to the default settings. You must re-add the event.
    • You can choose exactly one option for each criteria. For example, you can choose to forward notifications that are associated with a specific catalog. If you want to forward notifications from multiple catalogs to the same target, you must add an event for each catalog.

    The following table specifies which criteria can be modified.

    Event type Workspace Workspace criteria Additional criteria
    Asset Catalogs You can choose a catalog.
    Assets
    You can choose an asset.
    Asset actions
    You can choose an action.
    Data quality SLA violation Catalogs You can select catalogs. You can select assets.
    Data quality SLA assessment Catalogs You can select catalogs. You can select assets.
    Data quality issue Data quality You cannot modify the workspace. You can choose an area.
    Job Jobs You cannot modify the workspace. You can choose a job
    Job run Jobs You cannot modify the workspace. You can choose a job.
    Asset Projects You can choose a project.
    Assets
    You can choose an asset.
    Asset actions
    You can choose an action.
    Project Projects You can choose a project. No additional criteria.
    Project members Projects You can choose a project. No additional criteria.
    Data quality SLA violation Projects You can select projects. You can select assets.
    Data quality SLA assessment Projects You can select projects. You can select assets.
  9. On the External service tab, specify the information needed to connect to the external application:
    1. In the Target URL field, specify the URL of the webhook that accepts incoming HTTP requests.
    2. If you need to provide an SSL certificate to connect to the external application, paste the contents of the certificate into the SSL certificate field.
    3. Specify how you want to authenticate to the external application, you can specify either a username and password or a token.
    4. If the external application requires or supports any additional properties, specify the property name and value.
      For example:
      • The external application requires you to provide a unique ID to ensure that the payload is sent by a trusted source.
      • You want to specify that the notifications are being sent from a specific instance of IBM Software Hub
  10. Click Save.
  11. Click Activate to start forwarding notifications to the external application.