Webhooks

Incoming webhooks let you start test and suite runs by sending a simple POST request.

This is the easiest way to trigger runs from external tools such as CI pipelines, deployment scripts, workflow builders, or internal services when you do not need the extra control offered by the CLI or API.

This page covers only incoming webhooks. If you want to configure outgoing webhooks, see Sending webhook alerts.

Where to find your webhook URLs

Integrations page

Open your project and go to Integrations -> Webhooks.

This tab shows webhook URL templates with your project webhook token and a placeholder for the test or suite ID.

Integrations page

Test and suite actions

To get a webhook URL with specific test_id or suite_id without building it manually:

  1. Open the ... menu for a test or suite.

  2. Click Run via CLI or webhook.

  3. Open the Webhook tab.

  4. Copy the generated URL.

Tests list page
Run via modal

How to trigger a run

Send a POST request to the webhook URL.

No authentication header is required because the webhook token is embedded in the URL.

Example: run a test with CURL

Example: run a suite with CURL

Webhook response

If the request is valid, BugBug starts the run and returns 200 OK.

The response contains the following fields:

Field

Type

Description

id

UUID

ID of the created test or suite run

modified

datetime

Last update time of the run

status

string

Current run status, for example queued

webapp_url

URL

Direct link to the run details in the web app

Last updated

Was this helpful?