Configuring a webhook

You can configure a webhook to send notifications to a messaging application whenever an event occurs on HCL OneTest™ Server. You can configure a webhook at the server, team space, and project levels.

Before you begin

You must have completed the following tasks:

Ensured that you are assigned a role of a Project Owner in the project. See Managing access to the server projects.
Ensured that you are assigned a role as a Team Space Owner in the team space. See Managing members and their roles in a team space.
Created a project in your team space in HCL OneTest™ Server. See Adding a project.
Created a webhook template. See Configuring a webhook template.
Ensured that you have access to the messaging applications.
Created a channel type.
Configured your messaging application.
Copied the URL of the external communication application. See Creating an incoming webhook.

About this task

When you configure a webhook on HCL OneTest™ Server, you must copy the URL of the communication application in the Webhook URL field and paste the outgoing URL, and then select the events. You can select either all events or a subset of events.

You can be notified of the following types of events:

All Events
Team space Events
Project Events
Execution Events
License Events

Procedure

Log in to HCL OneTest™ Server.

The team space that contains your project is displayed.
Click Active projects > My projects > project_name to open the project that contains the test assets.

The Overview page of the project is displayed.
Click Manage > Webhooks in the navigation pane.
The TEMPLATES tab of Webhooks is displayed.
Click the WEBHOOKS tab, and then click New Webhook.

The New Webhook page is displayed.
Enter a name for the webhook and paste the URL that you copied in the Webhook URL field.
You must copy the URL while you configure your communication application.
Click the Channel Type, and then select a channel type from the list.
Enter a description for the webhook, and then select a template from the drop-down list.
A corresponding event that you configured for the template is displayed in the Events field.
Click the Templates icon, to add the templates that are configured for the channel type.

Note: If you want to change the events, then click the events option and select the required events.
You can perform any of the following steps:
1. Click move the template to a higher priority icon to move the template to a higher priority.
2. Click move the template to a lower priority icon to move the template to a lower priority.
Click Apply.
The webhook is created and added to the WEBHOOKS tab.

Results

You have configured and created a webhook on HCL OneTest™ Server to send notifications to the messaging application you configured.

What to do next

You can perform any of the following tasks:

You can duplicate or delete the template that you created on HCL OneTest™ Server. See Managing the webhook template configuration.
You can duplicate or delete the webhook you created on HCL OneTest™ Server. See Managing the webhook configuration.