Ghost Inspector with YAML

YAML parameters for Ghost Inspector

NameTypeDescription
action
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to GHOST_INSPECTOR.
integration_hash
Required
StringThe ID of the integration.
userStringThe name to associate with the event.
passwordStringThe password to associate with the event.
immediateBooleanUse to initiate the execution, then immediate return a response (without results).
disable_notificationsBooleanUse to disable all notifications for this execution only.
regionStringGeo-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.
browserStringAlternate 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.
suite_idStringThe ID of the suite to execute.
folder_idStringThe ID of the folder to execute.
channelStringSpecify the Slack channel to notify for this suite run. Note that the value must be myChannel or %23myChannel and not #myChannel.
viewportStringAlternate 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_fileStringA 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.
start_urlStringAlternate start URL to use for all tests in this execution only.
user_agentStringAlternate user agent to use for all tests in this execution only.

YAML example for Ghost Inspector

actions:
- action: "Ghost Inspector Action"
  type: "GHOST_INSPECTOR"
  user: "$login"
  password: "secure!h4323@hdfja"
  immediate: false
  disable_notifications: false
  region: "us-east-1"
  browser: "opera"
  suite_id: "5c9ca42171f8231b363ef760"
  suite_name: "buddy-tests"
  folder_id: "5cd01a1a8214512d421d8205143"
  channel: "slack_channel_name"
  viewport: "5c9ca42171f8231b363ef760"
  data_file: "variable.csv"
  start_url: "https://app.buddy.works/nickname"
  user_agent: "usernameghost"
  integration_hash: "5ddb7c180fb38be67bd78a88a"
  variables:
  - key: "login"
    value: "userLogin123"

Last modified on February 15, 2023

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

Sign up for free and deploy your project in less than 10 minutes.