Enabling a webhook

You can enable the webhook when push notifications about events occurring on HCL OneTest™ Server are not delivered to the configured webhook due to communication failures or network issues, and you receive a notification that the webhook is disabled.

Before you begin

You must have completed the following tasks:
  • Ensured that you are assigned the role of a Server Administrator, Team Space Owner or a Project Owner. If you are a server administrator, you can have three roles-server admin, team space owner, and project owner.
  • Configured a webhook. See Configuring a project webhook.

About this task

When a webhook is disabled due to communication failure or network issues, you are notified about the disablement of the webhook. Consequently notifications for the events are not delivered to the configured webhook and instead be queued for sending after you re-enable the webhook. You have the option to either send the queued messages or discard the queued messages.

Procedure

  1. Select from the following actions that you want to perform:
    • Enable a project webhook. Go to Step 2.
    • Enable a team space webhook. Go to Step 3.
    • Enable a server webhook. Go to Step 4.
  2. Perform the following steps to manually enable a project webhook:
    1. Log in to HCL OneTest™ Server.

      The team space that contains your project is displayed.

    2. Click Active projects > My projects > project_name to open the project that contains the test assets.

      The Overview page of the project is displayed.

    3. Click Manage > Webhooks.

      The TEMPLATES tab of Webhooks is displayed.

    4. Click the Webhooks tab, and then click the Disabled webhook option to enable a webhook that is disabled.
    The event notifications that were queued when the webhook was disabled are delivered to the configured webhook or discarded by HCL OneTest™ Server.This setting is based on the resume policy configuration that you set for the specific project webhook.
  3. Perform the following steps to manually enable a team space webhook:
    1. Log in to HCL OneTest™ Server.

      The team space that contains your project is displayed.

    2. Click the Settings settings icon icon on the navigation pane, and then click Manage team space.
    3. Click Webhooks.

      The TEMPLATES tab of Webhooks is displayed.

    4. Click the Webhooks tab, and then click the Disabled webhook option to enable a webhook that is disabled.

    The event notifications that were queued when the webhook was disabled are delivered to the configured webhook or discarded by HCL OneTest™ Server. This setting is based on the resume policy configuration that you set for the team space webhook.

  4. Perform the following steps to manually enable a server webhook:
    1. Log in to HCL OneTest™ Server.

      The team space that contains your project is displayed.

    2. Click the Settings settings icon icon on the menu bar, and then click Webhooks.

      The TEMPLATES tab of Webhooks is displayed.

    3. Click the Webhooks tab, and then click the Disabled webhook option to enable a webhook that is disabled.
    The event notifications that were queued when the webhook was disabled are delivered to the configured webhook or discarded by HCL OneTest™ Server. This setting is based on the resume policy configuration that you set for the server webhook.

Results

You enabled the webhook on HCL OneTest™ Server to push notifications of the events that failed to be delivered to the configured webhook.