Webhooks integration package

Webhooks serve as a communication mechanism between systems. A webhooks subscribes to HCL Compass and waits. When events are triggered, HCL Compass sends information out the subscriber.

The Webhooks integration package installs into HCL Compass like any other integration package. The webhooks integration package allows you to:
  • Create a webhook configuration (WebhookConfig) for a server that wants to be notified of events that occur in HCL Compass.
  • This configuration allows the user to select states and/or actions that the server should be notified of.
  • The user or other users use HCL Compass as they need. For example, creating, assigning, resolving, duplicating, postponing defects.
  • Anytime an action or state change occure that matches with what was selected in the configuration, a payload (WebhookData) is created by HCL Compass.
  • Periodically, the REST API server checks for webhooks, and then checks for payloads to deliver to those webhooks.

By default, webhooks configurations are refreshed every 15 minutes. WebhookData objects are polled every minute, deleted upon successful delivery, and tries 10 attemps.