latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Event

Trigger tests on deployment

Create a deployment event to trigger a parallel run of all active plans that meet specified conditions, including application, environment, and plan label. Learn more in the docs.

post/events/deployment

Query parameters

previewboolean

Set to true to preview what would be run

Request body

idstring

Unique ID for this event, set by mabl

environment_idstring

The ID of the environment. When provided, mabl only triggers plans that contain this environment.

application_idstring

The ID of the application. When provided, mabl only triggers plans that contain this application.

workspace_idstring

The ID of the workspace associated with this deployment, set by mabl

event_timeinteger

Time at which the deployment occurred

received_timeinteger

Time at which the deployment event was received by the API

revisionstring

The source code revision associated with the deployment

propertiesobject

Arbitrary key-value pairs used to pass additional information about this deployment

target_runtime_versionstring

Target execution test runner image tag to execute

target_orchestration_versionstring

Optional orchestration runtime version to use, if applicable. Otherwise use default orchestration version.

debugboolean

If true will capture additional debugging information during execution of triggered test runs. Support admin or feature flag required.

plan_labelsstring[]

If specified, only plans matching the given labels will execute

source_control_tagstring

deprecated, use branch

branchstring

The mabl branch to run tests from

Response

The deployment event was created

idstring

Unique ID for this event, set by mabl

environment_idstring

The ID of the environment. When provided, mabl only triggers plans that contain this environment.

application_idstring

The ID of the application. When provided, mabl only triggers plans that contain this application.

workspace_idstring

The ID of the workspace associated with this deployment, set by mabl

event_timeinteger

Time at which the deployment occurred

received_timeinteger

Time at which the deployment event was received by the API

revisionstring

The source code revision associated with the deployment

propertiesobject

Arbitrary key-value pairs used to pass additional information about this deployment

target_runtime_versionstring

Target execution test runner image tag to execute

target_orchestration_versionstring

Optional orchestration runtime version to use, if applicable. Otherwise use default orchestration version.

debugboolean

If true will capture additional debugging information during execution of triggered test runs. Support admin or feature flag required.

plan_labelsstring[]

If specified, only plans matching the given labels will execute

source_control_tagstring

deprecated, use branch

branchstring

The mabl branch to run tests from