Antithesis logomark
DOCS

Webhook parameters (Deprecated)

The following parameters can be used to configure a webhook.

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:

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

antithesis.config_image

string

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"

antithesis.description

string

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.


antithesis.duration

string

Desired duration of your test run in minutes.


antithesis.filter_logs_matching

string

An RE2 pattern matching log lines to suppress while Antithesis fuzzes your software. Suppressed lines can be recovered in a multiverse debugging session. This is Retroactive logging, and it lets you keep verbose logging without slowing down exploration of your system.

Matching is unanchored and case-sensitive: any line containing a match is suppressed. Prefix the pattern with (?i) for case-insensitive matching. Lookahead, lookbehind and backreferences are not supported. Prefer a simple substring or basic pattern over a full-featured regex.

This parameter is represented in the test launcher dialogue as the “Filter logs matching” advanced parameter.

Examples:

  • "antithesis.filter_logs_matching": "(?i)^\\s*(TRACE|DEBUG)\\b" matches lines whose first non-whitespace token is the log level.
  • "antithesis.filter_logs_matching": "(?i)\"level\":\"(trace|debug)\"" matches a JSON log field instead, for structured loggers that lead with a timestamp.

antithesis.filter_source_matching

string

An RE2 pattern matching the sources whose output should be suppressed while Antithesis fuzzes your software. antithesis.filter_logs_matching picks out individual lines by their content but this suppresses a matching source’s output in its entirety, which is useful for silencing one chatty component outright. Suppressed output remains recoverable in a multiverse debugging session. See Retroactive logging.

A source is the emitter of a log line, usually the name of the process that wrote it. The source field on each log line shows the names available to match against; use them exactly as they appear there, especially if you intend to anchor your pattern.

Unlike antithesis.filter_logs_matching, this parameter has no corresponding field in the test launcher dialogue: set it through the API, a webhook, or Snouty’s --param flag.

Matching is unanchored and case-sensitive, and is applied to the source name rather than to the log line. Prefix the pattern with (?i) for case-insensitive matching. Lookahead, lookbehind and backreferences are not supported. Prefer a simple substring or basic pattern over a full-featured regex.

Examples:

  • "antithesis.filter_source_matching": "metrics-agent" suppresses every source whose name contains metrics-agent.
  • "antithesis.filter_source_matching": "^metrics-agent$" names that one source exactly.

antithesis.images

string

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.

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"

antithesis.is_ephemeral

string

A boolean (represented as "true" or "false") that indicates whether or not webhook’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 as the “Show in findings history?” checkbox.


antithesis.report.recipients

string

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"

antithesis.source

string

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.


antithesis.test_name

string

An optional name for the test you are running.

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, these parameters are automatically configured and you will not need to set them manually.


antithesis.integrations.<INTEGRATION_TYPE>.callback_url

string

The callback URL.


antithesis.integrations.<INTEGRATION_TYPE>.token

string

A secret token.


<INTEGRATION_TYPE>

string

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:

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.


antithesis.integrations.type

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


antithesis.integrations.callback_url

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


antithesis.integrations.token

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