Webhooks in Zoho QEngine

Webhooks in Zoho QEngine

In a nutshell 
Webhooks in Zoho QEngine are configurable endpoints that allow you to send test execution data to an external system using its webhook URL. Once you set up a webhook and link it to a test plan, QEngine can trigger it on events such as test start, completion, success, or failure. When these events occur, QEngine pushes structured execution data to your chosen system, enabling real-time alerts, integrations, and automated workflows.
Availability 
  1. Super admins, admins, managers, and testers can view, create and edit, and manage webhooks.

1. Overview  

Webhooks in Zoho QEngine act as a real-time communication bridge between QEngine and external systems. Instead of waiting for users to manually check execution reports, webhooks allow QEngine to actively notify other applications the moment a defined execution event occurs, such as when a test run starts, completes, succeeds, or fails.  
 
When the configured event occurs, QEngine sends an HTTP request to the target endpoint. The request contains a structured JSON payload containing key test plan execution details, such as the test plan ID, execution run ID, status, and more. External systems can use this payload to parse easily and automate follow-up actions, such as creating notifications, updating dashboards, logging results, or triggering workflows in other tools.
 
For example, you can configure a webhook to send a short text update to a Zoho Cliq bot whenever a test run begins or finishes, allowing teams to receive quick execution alerts directly in their chats.
 
Beyond simple alerts, webhook events can also serve as powerful workflow triggers for broader automation in external applications. For example, webhooks can be used to call external APIs that validate the incoming data before forwarding it to downstream systems. Webhooks can also initiate internal scripts or CI/CD tasks, such as forwarding execution details to a Git-based pipeline or updating a custom API that tracks test activity. In these setups, a single webhook event becomes the starting point for a larger automated sequence, where multiple external tools handle data processing, enrichment, or reporting without requiring manual intervention.

Defining webhook
A webhook in QEngine specifies where the test plan execution data should be delivered and how that request should be structured. When creating a webhook, you provide its connection details such as name, endpoint URL, URL parameters, and headers, which QEngine uses to send structured execution data to the intended system.

Defining events
The conditions that trigger a webhook are configured at the test plan level. When you associate a webhook with a test plan, you can choose whether it should trigger when an execution starts, completes, succeeds, or fails. For success and failure events, you can also define the minimum completion percentage required before the webhook is triggered. A single webhook can be reused across multiple test plans, each with its own event-specific configuration.

 

Traceability

Every webhook activity is logged within QEngine, where every invocation is recorded with its corresponding status and message. These logs ensure full visibility, helping you audit outgoing notifications and troubleshoot any failures. 

2. Create webhook 

Webhooks are created within a specific project and are available for use only within that project’s test plans. Creating a webhook involves defining its destination, method, and additional request details.

  1. Navigate to Settings > Webhooks. Click +Create Webhook.

 

  1. Enter a Webhook Name. Optionally, provide a description.



  2. Select the method from GET or POST. Make sure you choose the method required by the target service to perform the required webhook action.

  3. Enter the Webhook URL where the request should be sent. This URL is provided by the external service you are integrating with. For example, the webhook URL of a notification bot, the API endpoint of an automation tool, or any custom API URL that accepts incoming requests.



  4. Specify URL Parameters based on the requirements of the target service. The Result parameter is included by default and can't be removed, it carries the execution payload that QEngine sends to the endpoint.



    If additional parameters are required, such as an API key, authentication token, or other service-specific fields, use the + icon to add them. You can remove any additional parameter you’ve added using the delete icon {}. 

  5. Add Headers if your target service requires them (for example, Content-Type or authentication headers), ensuring each header includes a valid key–value pair. 


    Use the + icon to add multiple headers. The delete icon {} allows you to remove any headers you’ve added.

  6. Click Create to save the webhook.
Once created, these webhooks can be associated with one or more test plans, allowing you to configure when it should be triggered for each execution event.

3. Associate webhooks with test plans 

Webhooks define the destination for execution data, but they only become active when mapped to a test plan. In this section, you’ll associate a webhook with a test plan and specify the execution events that should trigger it. Only webhooks created within the same project will be available for selection during this association.
  1. Navigate to Test Plans. This is where you link a webhook to a specific test plan and define the conditions under which it should be triggered. 


     
  2. Create a new test plan or open an existing one. The webhook should be triggered based on the execution of this specific test plan.

  3. Scroll to the Webhooks section and click + Add Webhooks. This opens a dialog where you map execution events to your webhook.


     

  4. Configure the trigger: 



    1. When: Select the condition under which the webhook should be triggered. Options include Started, Completed, Success, and Fail.
      NotesNote: When configuring a webhook for the Success or Fail condition, you must specify the minimum percentage (%) of test plan completion that must pass or fail for the webhook to be triggered.

    2. Webhook: Choose a webhook from the dropdown, which lists all the previously created ones. Learn more on how to create webhooks

  5. Click Save to associate the webhook with the test plan. The selected webhook will now be listed in the webhooks section of the test plan.



  6. After adding all required webhooks, choose one of the following:

    1. Click Update if modifying an existing plan.

    2. Click Create if this is a new plan. 

Your webhook triggers will now activate during execution based on the conditions you configured.

4. Manage webhooks 

The manage actions inside allow you to view, modify, remove, and monitor all created webhooks from a single place. 

4.1 View 

Use View to access all created webhooks and review their key configuration details, including the Webhook Name, Webhook URL, and Recent Execution information.

 

4.2 Edit 

You can easily modify the details inside a configured webhook.

  1. Click the required webhook from the list.



  2. Make the required changes and click Update to save them.

4.3 Delete 

Use Delete to permanently remove a webhook that is no longer required. Once deleted, it cannot be associated with any test plan.

  1. Hover over the required webhook and click on delete icon.

Notes


Note:
To delete a webhook that’s in use by any test plans, you must remove those associations before deleting it.

4.4 View Logs 

Use View Logs to monitor webhook delivery history, troubleshoot failed webhook requests, and verify successful communication with external systems. This section helps you analyze webhook performance and ensure your configured endpoints receive the correct data.
  1. Click View Logs to open the webhook logs that track all payload delivery events.



    Each log displays important diagnostic information, including Webhook Name, Webhook URL, Status, and Message for every request. The logs are sorted so that the most recent attempts are shown first by default.

  1. Click any log entry to view its drill-down information, such as request details, response body, and response headers. You can view them in both Raw and Pretty formats.



  2. Use the filters (All, Passed, and Failed) to quickly narrow down webhook results and troubleshoot specific issues.   

5.  See how it works

In this video, you’ll learn how to set up webhooks in QEngine, link them to your test plans, and review their execution results.

 

 

 6. Related links