API Reference
mabl helprelease notesfeature requestssystem status

Trigger tests on deployment

post
https://api.mabl.com/events/deployment

Create a deployment event to trigger a parallel run of all active plans that meet specified conditions, including application, environment, and plan label, or specific plans named by ID. 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.

plan_ids
array of strings
length between 1 and 50

If specified, mabl runs these plans in addition to any matched by plan_labels. Without plan_labels, only these plans run. Each id must name an enabled plan in this workspace with a deployment trigger, on a deployment matching the event environment_id and application_id, otherwise the event is rejected with a 400 and nothing runs. At most 50 entries, and a repeated id runs once

plan_ids
test_selection
object

A specific set of tests to run on this deployment, up to 50. mabl runs them together as one plan run. When provided with plan_labels, the matching plans also run.

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. Combined with plan_ids, a plan runs if it matches either

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

Updated 6 months ago

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

Updated 6 months ago

Did this page help you?