Set Up Webhooks

Webhooks are used to exchange the data about certain events between different services. TestGear uses webhooks for integrations with messengers and CI/CD systems. To set up webhooks, you need a ProjectAdmin project role or any other role with Full access rights to manage webhooks.

Create Webhooks

  1. Open a project.

  2. Go to project settings.

  3. Switch to the WebHooks tab.

  4. Click New WebHook.

  5. Specify the following parameters:

    • Name - the name displayed in the webhook list.
    • Event - the type of event that triggers the webhook. You can choose Autotests run was created and Change test plan status.
    • Description - short description of your webhook.
    • URL - the address of the service to send requests to.
    • Request type - type of request that is sent to the service (POST, PUT, and DELETE)
    • HTTP headers and URL parameters - headers and parameters sent by a webhook to a service. You can use special variables to send data associated with a certain event. To view the list of available variables, enter $ in the Value field and choose the variable from a drop-down list. For more information on parameters and headers, see Webhook for Autotests Run and Webhook for Test Plan Status Change.
  6. For POST and PUT requests, set up the request body format. In the HTTP Body field, choose:

    • Do not send
    • Send standard context - sends a preset data model.
    • Send custom context - enables you to replace system parameters to declare variables using $, and escape parameters to render special symbols in .xml and .json files correctly.
  7. Save the webhook by clicking New webhook.

Edit and Delete Webhooks

  1. Open a project.

  2. Go to project settings.

  3. Switch to the WebHooks tab.

  4. Expand a webhook you want to edit or delete. Make your edits.

  5. Click Save or Delete in the bottom right corner of the webhook.