UiPath Documentation
test-manager
latest
false
Test Manager user guide

Configuring Webhook connection

Register, edit, or delete a webhook connection so external tools receive defect and KPI event payloads from your project.

A webhook connection sends event payloads, such as defect creation and key performance indicator (KPI) updates, from a project to an external tool.

Registering a webhook connection​

Register a webhook connection in Project Settings > Integration as an administrator. The connection gives you an API Key to copy for later use.

Steps​

  1. Log in to Test Manager as an administrator.

  2. Open your project.

  3. Navigate to Project Settings > Integration.

  4. Select New Connection and select WebHook from the dropdown.

  5. Configure the following connection settings:

    • Name: Enter a name for your webhook connection.
    • Description (Optional): Add a description for reference.
    • Payload URL: Add the endpoint server URL. For example: https://company-name-serverRegion.cloudapp.azure.com.
    • Authentication Header Type: Select a hashing method between Client Secret and HMACSHA256.
    • Secret: Enter your client secret value.
    • Allow Insecure SSL: Choose whether to allow endpoints with insecure SSL connections.
    • Supports Defect Dashboard: Choose if KPIs need to be shown in the project dashboard.

  6. Select Save.

  7. Select the connection to expand the panel and copy the API Key for later use.

Result​

The webhook connection is created. External tools can now subscribe to Test Manager events such as defect creation and KPI updates from the connected project.

Editing a webhook connection​

Editing a connection changes the settings of an existing webhook connection.

Steps​

  1. Log in to the Test Manager as an administrator.
  2. Open your project.
  3. Go to Project Settings.
  4. In the Integration list, select a webhook connection to expand the panel.
  5. Select Edit to configure the connection.
  6. Select Save to confirm.

Result​

The webhook connection settings are updated.

Deleting a webhook connection​

Deleting a connection removes it together with its associated requirements.

Steps​

  1. Log in to the Test Manager as an administrator.
  2. Open your project.
  3. Go to Project Settings.
  4. In the Integration list, select a webhook connection to expand the panel.
  5. Select Delete to remove the connection.
  6. Select Ok to confirm.

Result​

The webhook connection and its associated requirements are deleted.

  • Registering a webhook connection​
  • Steps​
  • Result​
  • Editing a webhook connection​
  • Steps​
  • Result​
  • Deleting a webhook connection​
  • Steps​
  • Result​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated