Webhooks

Introduction

Webhook allows TestCLIX to send real-time notifications to your system whenever a scenario run finishes.

Instead of manually checking results, you can automatically trigger workflows such as:

• CI/CD deployments
• Monitoring and alerting
• Reporting pipelines
• Custom integrations

Webhook is delivered as an HTTP POST request containing a JSON payload with execution details.

Webhook events are triggered when scenario test run results are available.

Note

Webhook is intended for server-to-server communication and should be handled by a publicly reachable backend endpoint.

Configuration

You can enable and manage Webhook from the application Settings. Configuring it requires the Admin or Owner role in the current project - see Roles & Permissions.

1. Open Settings from the left sidebar menu.

2. Select Webhook.

3. Turn Webhook notifications ON.

4. Enter your Webhook endpoint URL.

5. (Optional) Configure a Webhook secret for request verification.

6. (Optional) Add up to 10 custom headers.

7. Click Save to apply your changes.

   

Webhook Request Format

Webhook requests are sent as HTTP POST calls.

Request Example

POST /webhooks/testclix HTTP/1.1
Host: your-endpoint.com
Content-Type: application/json
X-Clix-Signature: a1b2c3d4e5f6...

Webhook Payload

Webhook request contains a JSON payload describing the completed scenario run.

Payload Fields

Field	Type	Description
test_id	string	Unique identifier of the scenario run
status	string	Result: Pass or Error
timestamp	number	Unix timestamp of the event
created_at	string	Scenario start time in ISO format

Example Payload

{
  "timestamp": 1696332892.123456,
  "test_id": "TEST_ID_EXAMPLE",
  "status": "pass",
  "created_at": "2022-08-17T09:57:39Z"
}

Webhook Secret & Signature Verification

To verify that Webhook requests originate from TestCLIX, you can configure a Webhook secret.

When a secret is enabled, Webhook request includes the following header:

X-Clix-Signature

How the Signature Works

The signature is generated using:

• HMAC-SHA1
• Your configured Webhook secret
• The raw JSON request payload

This allows your server to confirm that the request was sent by TestCLIX and was not modified by a third party.

Note

If no Webhook secret is configured, the X-Clix-Signature header will not be included. We strongly recommend enabling signature verification in production environments.

Signature Format

The signature is sent in the request header using the following format:

X-Clix-Signature: <signature>

Note

• Always compute the signature using the raw request body (before JSON parsing).
• Reject requests with missing or invalid signatures.
• Keep your Webhook secret stored securely.

Retry Behavior

If your endpoint does not respond with a 200 OK status, TestCLIX will automatically retry the webhook delivery up to 3 times.

Test Your Webhook

Send a test payload to validate configuration:

1. Click the Test Webhook button.

2. Verify reception at your endpoint.

3. Check signature validation.

4. Confirm with 200 OK response.