Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for Ghost Inspector

View as Markdown

Run Ghost Inspector automated browser tests.

YAML parameters for Ghost Inspector

PARAMETERS
integrationrequiredstring
Ghost Inspector integration for authentication.
typerequiredstring

Value: GHOST_INSPECTOR

actionrequiredstring
Unique identifier for the action within the pipeline.
regionstring
Geo-location for test execution. The following options are available: us-east-1, us-west-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, eu-north-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, sa-east-1
folderstring
The ID of the folder to execute
suitestring
The ID of the suite to execute
browserstring
Alternate browser to use for this execution. The following options are available: firefox (default), firefox-<version> specific version of Firefox, for example firefox-57, chrome (paid plans only), phantomjs
channelstring
Specify the Slack channel to notify for this suite run. Note that the value must be myChannel or %23myChannel and not #myChannel
userstring
The name to associate with the event
passwordstring
The password to associate with the event
immediateboolean
Use to initiate the execution, then immediate return a response (without results)
disable_notificationboolean
Use to disable all notifications for this execution only
start_urlstring
Alternate start URL to use for all tests in this execution only
user_agentstring
Alternate user agent to use for all tests in this execution only
viewportstring
Alternate screen size to use for all tests in this execution only. This should be a string formatted as {width}x{height}, for example 1024x768
data_filestring
A CSV file containing a row of variable values for each suite run. A POST request must be used when sending this file. When included, an array of suite results will be returned instead of an array of test result
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.
run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Apr 27, 2026

Previous pageGenerate variablesNext pageGhost Inspector CLI

YAML examples for Ghost Inspector

Run Ghost Inspector tests

yaml
  - action: "Run Ghost Inspector tests"
    type: "GHOST_INSPECTOR"
    trigger_time: "ON_EVERY_EXECUTION"
    integration: "my_ghost_inspector"
    suite: "my-test-suite"
    browser: "chrome"
    region: "us-east-1"
    start_url: "https://staging.example.com"
    viewport: "1920x1080"
    immediate: true
    disable_notification: false