Launching a debugging session

This endpoint kicks off a multiverse debugging session for a target test run that’ll be available for six hours.

You’ll receive an email with a link to access your session ~5-10 minutes after you call the webhook. If your request is malformed (e.g. an invalid parameter), you’ll receive a non-200 response or a failure email almost immediately.

Once you have the access link, you can start debugging in the Antithesis Notebook.

The target test run is identified by antithesis.debugging.run_id. For backwards compatibility, antithesis.debugging.session_id is also accepted but prefer run_id for new integrations.

curl --fail -u 'USER:PASSWORD' \
-X POST https://<TENANT>.antithesis.com/api/v1/launch/debugging \
-d '{"params": {
        "antithesis.debugging.run_id":"d5d1c9cf0e64b5dd69b00e97b07fe3f4-18-1",
        "antithesis.debugging.input_hash":"-9067336385060865277" ,
        "antithesis.debugging.vtime":"45.334635781589895",
        "antithesis.report.recipients":"YOUR_EMAIL@DOMAIN.com"
    }}'

Authentication

Antithesis webhooks use basic auth credentials for authentication.

<USER>:<PASSWORD>

The basic auth machine credentials for your tenant.

<TENANT>

Your tenant’s name.

Parameters

These parameters are passed as JSON according to the following template:

{
    "params": {
        "parameter1_name": "parameter1_value",
        "parameter2_name": "parameter2_value",
    }
}

You can request a debugging session using either antithesis.debugging.run_id or antithesis.debugging.session_id. Although they are not marked as required below, you must provide either one of them in your request.

antithesis.debugging.input_hash

string · required

Obtain the input_hash from the copy moment button in the triage report.

antithesis.debugging.run_id

string

Run ID of the test run you want to start debugging. Obtain it from the runs view by copying from the ⋮ menu of the run, or by copying it from the bottom of the triage report.

Although this parameter is not marked as required, you need to provide either the run ID or the session ID of the test run to debug in the request. Prefer run_id over session_id for new integrations.

antithesis.debugging.session_id

string

Session ID of the test run you want to start debugging. Obtain it from the copy moment button in the triage report.

antithesis.debugging.vtime

string · required

The vtime at which you want to start debugging. Obtain it from the copy moment button in the triage report.

antithesis.report.recipients

string

A ;-delimited list of recipients who’ll receive emailed links to the triage report produced by this test run.
If this parameter is not specified, emails will be sent to the default users set up for the endpoint.

Examples:

"antithesis.report.recipients": "u1@site.com; u2@site.com"