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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Set to true to preview what would be run

Body Params

The deployment event

Describes a deployment event

plan_overrides
object

Overridable Plan attributes

string

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

test_selection
object

An explicit set of tests to run for a deployment, in place of matching stored plans by label. mabl runs them as one synthesized plan whose identity is scoped to the event, so the runs appear on the deployment results page like any other deployment run. Supports browser or API tests, without mixing types. Each test runs at its version on the selection's mabl branch, falling back to master when it has none there. That branch is the event's branch (or source_control_tag), else the deployment's branch, else the snapshot action's from, else the environment's branch, else master, and must be the same for every deployment that can run the selected test type. A branch mabl does not have is not an error: every test runs at master, and resolved_tests shows it. The snapshot action's from is the exception and must name an existing branch. A test with no version on the branch or master is refused. An environment's snapshot branch has no master fallback, so a test missing from the snapshot is refused. Each enabled test requires a compatible deployment. The first run runs the versions in resolved_tests. Retries, from retry_failed_tests or a manual rerun, resolve the branch again and run any later edit. Flows are not pinned; they resolve on the branch when each test starts.

triggered_plan_run_summaries
array of objects

Summary of the plans that were triggered by this deployment event

triggered_plan_run_summaries
plan_labels
array of strings
length ≥ 1

If specified, only plans matching the given labels will execute

plan_labels
string

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

string

The mabl branch to run tests from

string

deprecated, use branch

string

The source code revision associated with the deployment

actions
object

Actions to give mabl for this deployment

Responses

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json