Deployment webhooks

Deployment webhooks run a test plan when an external system calls the generated webhook URL.

For a complete CI example, see the GitHub Actions integration.

Payload

Send a JSON body with a message and optional Base URL override:

{
  "message": "Production deploy 8f4a21d",
  "overrideBaseUrl": "https://preview.example.com"
}

overrideBaseUrl is optional. When provided, the run uses it instead of the project's default Base URL.

When to use an override

Use overrideBaseUrl for preview deployments, branch environments, or staging URLs that change per deployment. Do not use it to point a production plan at an environment your credentials and test data are not prepared to use.

Failure review

Webhook-triggered failures should be reviewed with deployment context: commit, environment, branch, deployment URL, and run evidence.