> ## Webhook parameters

> Fetch the complete documentation index at: https://antithesis.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

---

The following parameters can be used to configure a webhook.

```bash
curl --fail -u 'USER:PASSWORD' \
-X POST https://<TENANT>.antithesis.com/api/v1/launch/<ENDPOINT> \
-d '{"params": { 
    "param_1":"value_1",
    "param_2":"value_2",
    ...
    } }'
```

All parameters are optional.

If you want additional ways to parametrize your tests, we can create custom parameters for you, just reach out at support@antithesis.com.

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

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

The image version of your config image. This should be a single image version formatted in the same way as those in the `antithesis.images` parameter.

Examples:

- `"antithesis.config_image": "image_name:latest_tag"`

A description of your test run that'll be in the headers of the generated report and of any emails triggered by the test run.

Desired duration of your test run in minutes.

A `;`-delimited list of image versions of the software to be tested. Each entry in the format `[REGISTRY/]NAME(:TAG|@DIGEST)`. In most cases, the set of images will be parsed from the orchestration configuration and does not need to be specified in this parameter. For Docker Compose, images will be read from the `docker-compose.yaml` file and for Kubernetes the `/manifests` directory.

It's recommended to use a `digest` over a `tag`. Images specified by digest will be tagged as `latest` within [the Antithesis environment](/docs/configuration/the_antithesis_environment/).

The default registry will be `us-central1-docker.pkg.dev/molten-verve-216720/$TENANT_NAME-repository/`.

When images mentioned in the config (in `docker-compose.yaml` or in `manifests/`) are also passed via the `antithesis.images` param, the latter overwrites the former. Eg. if your config contains `postgres:17.2` and you pass `docker.io/ubuntu/postgres:17.2` in the param, the image tagged `17.2` will be pulled from the `ubuntu` repository.

We recommend you only use the `antithesis.images` param for passing images not mentioned in the config files.

Examples:

- `"antithesis.images": "registry/container:some_tag"`
- `"antithesis.images": "container_1@sha256:12341234; registry/container_2:latest_tag"`
- `"antithesis.images": "registry/container_1:sha256:12341235; registry/container_2:latest_tag; container_3@sha256:56785678"`

A boolean (represented as `"true"` or `"false"`) that indicates whether or not webhooks's results should be reflected in future reports as a historic result.

- Set this to `"true"` when kicking-off one-off, exploratory runs.  Failing to set this will result in confusing test history.
- Leave this `"false"` (which is the default) when running scheduled tests.

This parameter is represented in the [test launcher dialogue](/docs/product/test_launchers/) as the "Show in findings history?" checkbox.

A `;`-delimited list of recipients of 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": "foo@my-site.com"`
- `"antithesis.report.recipients": "u1@site.com; u2@site.com"`

An identifier to separate property history in reports.

In the resulting report, each property's history is generated from all previous runs with the same `antithesis.source` parameter. This allows you to (for example) easily see the history of tests on a single branch.

The parameter may be arbitrary text, but you will likely provide a source control descriptor.

#### Tooling integration parameters

These parameters allow you to post the results of test runs back to the platform of your choice. In some cases, such as the Antithesis [Github action](/docs/product/tooling_integrations/ci/#github-actions), these parameters are automatically configured and you will not need to set them manually.

The callback URL.

A secret token.

Accepted integration types are `github`, `discord`, and `slack`.

You may post results back to as many different platforms as you like. For example, the following will post results back to both Discord and to Github:

```bash
curl --fail -u 'USER:PASSWORD' \
    -X POST https://<TENANT>.antithesis.com/api/v1/launch/<ENDPOINT> \
    -d '{"params": { "antithesis.description":"Nightly testing on main", 
        "antithesis.integrations.discord.callback_url": "https://discord.com/api/webhooks/1234567890123456789/",
        "antithesis.integrations.discord.token": "<SECRET>",
        "antithesis.integrations.github.callback_url": "<URL>",
        "antithesis.integrations.github.token": "<SECRET>",
        "antithesis.images":"my_images_with_version_list" } }'
```

---

### Deprecated parameters

The following parameters are **deprecated**.

The CI / Source Control integration type.
Values: `["none", "github"]`.
Default value: `"none"`.

The URL Antithesis will call back to post the test results.

A security token used to authenticate when calling back with results.
