Managing the webhook template configuration

You can manage the webhook template configuration that you set on HCL DevOps Test Hub (Test Hub) when you want to edit, duplicate, delete the existing webhook templates, or create new templates. Before you create a webhook, you can view the templates created at server, team space, and project levels. Additionally when you create a project, team space or server webhook you can utilize the corresponding templates associated with them.

Before you begin

You must have completed the following tasks:

Procedure

  1. Log in to Test Hub.

    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 in the navigation pane.

    The TEMPLATES tab of Webhooks is displayed.

  4. Perform the tasks indicated in the following table:
    Task Action
    Configuring a webhook template Click the New Template option to configure a webhook template. See Configuring a webhook template.
    Viewing webhook templates You can view the following details about the project and team space templates:
    1. The Show all levels option enabled.
    2. The following icons that display the server, team space, and project webhook templates in the From column.
      • Project template icon project template
      • Team space template icon team space template
      • Serve template icon server template

      As a project owner, you can view project, team space, and server templates on the project template page. Similarly, as a team space owner, you can view only team space and server templates on the team space template page.

    Perform the following steps to view project or team space templates:
    1. Click the Hide other levels option.

      You can only view project webhook templates, if you are on the project template page, and you can only view team space templates, if you are on the team space template page.

    2. Click the Action icons to edit, duplicate view or delete the templates.
      Note: As a Project Owner, you can edit the project webhook templates; however, you can only view and clone the details of server webhook templates or team space webhook templates. If you are a Team Space Owner you can edit the team space templates; however, you can only view and clone the details of server webhook templates. If you clone a webhook template, then you can edit or delete a webhook template.
    Editing a webhook template Perform the following steps to edit the webhook template:
    1. Click the Edit template icon edit icon.

      The Edit template page is displayed.

    2. In the Details tab, you can enter a new name for the webhook template, or select any other value for the options.
    3. In the Templates tab, you can also edit or select a template based on the channel type you selected on Details tab.
    4. Click Apply.

      The edited template is saved to the TEMPLATES tab.
    Cloning a webhook template Perform the following steps to duplicate the webhook template:
    1. Click the Duplicate template icon duplicate icon.

      The Duplicate template page is displayed.

    2. In the Details tab, you can edit or modify the values by entering a new name for the webhook template, by selecting a Channel Type, or Events.
    3. In the Templates tab, you can edit or select other webhook template based on the channel type you selected on Details tab.
    4. Click Apply.

      The cloned webhook template is added to the TEMPLATES tab.
    Deleting a webhook template

    Perform the following steps to delete the webhook template:

    1. Click the Delete Template icon delete.

      The Delete template confirmation dialog is displayed.

    2. Select the I understand template deletion is permanent checkbox, and then click Delete.

      The webhook template is removed from the template list.

Results

You achieved the following results:
  • Edited and saved a webhook template configuration.
  • Cloned a webhook template configuration.
  • Deleted a webhook template configuration.