Skip to main content

Webhooks

Configure webhooks to send real-time HTTP POST callbacks to your endpoints when events occur in Qase.

Updated yesterday

πŸ‘‰ Available in ALL paid plans.

Webhooks send real-time HTTP POST callbacks to your endpoints when events occur in Qase β€” enabling custom integrations, audit logging, and workflow automation without polling the API.

Overview

A webhook listens for specific events in a Qase project (e.g., a test run completing, a defect being created) and sends a JSON payload to an endpoint you control. You can use webhooks to trigger CI pipelines, update dashboards, sync with internal tools, or feed events into a data warehouse.

Webhooks are configured per project. Each webhook targets one endpoint but can subscribe to multiple event types.

Creating a Webhook

  • Open your project's Settings β†’ Webhooks.

  • Select Create new webhook.

  • Fill in the configuration:

Field

Description

Title

A descriptive name (e.g., "Slack notifier" or "CI trigger on run complete")

Endpoint

The publicly accessible URL that will receive the POST request

Secret

An optional string sent as the X-Qase-Secret header so your endpoint can authenticate requests

  • Under Events, select which events should trigger this webhook (see full list below).

  • Save.

Supported Events

Entity

Events

Test Cases

Created, updated, deleted, cloned

Test Suites

Created, updated, deleted, cloned

Test Plans

Created, updated, deleted

Shared Steps

Created, updated, deleted

Milestones

Created, updated, deleted

Custom Fields

Created, updated, deleted

Test Runs

Started, aborted, cases added, deleted, completed, public link enabled

Defects

Created, resolved, deleted

Reviews

Created, updated, approval status changed, reviewer added/removed, merged, reopened, commented, declined, deleted

Results

Created, updated, deleted

Example Payloads

For detailed information on what the payload for each of these events contain, refer to this page:

Authentication

Use the optional Secret field to set a shared secret. Qase includes this value in the X-Qase-Secret header of every request.

Your endpoint can validate this header before processing the payload to prevent spoofed requests.

Auto-Disable Behavior

Qase automatically disables a webhook if:

  • The endpoint does not respond within 15 seconds.

  • The webhook fails to deliver successfully over a 2-day period.

When a webhook is auto-disabled, you receive an email notification. Re-enable it from Settings β†’ Webhooks after fixing the endpoint issue.

Testing and Debugging

  • Start simple β€” use a request inspection tool (like webhook.site or RequestBin) as your endpoint to verify payloads before pointing to your production service.

  • Check headers β€” every request includes Content-Type: application/json and X-Qase-Secret (if configured).

  • Monitor the toggle β€” if your webhook appears disabled unexpectedly, check your endpoint's availability and response time.

FAQ

Can I send multiple event types to the same endpoint?
Yes. A single webhook can subscribe to any combination of events. Your endpoint can inspect the event_name field to route handling.

Are webhook deliveries retried?
Qase does not retry individual failed deliveries. If your endpoint is down, the event is lost.

Did this answer your question?