Ghost Inspector

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required		StringThe name of the action.
type
Required		StringThe type of the action. Should be set to GHOST_INSPECTOR.
integration_id
Required		IntegerThe 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.
suite_nameStringThe name 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.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions

JSON

{
  "name": "Ghost Inspector Action",
  "type": "GHOST_INSPECTOR",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "variables": [
   {
      "key": "filePath",
      "value": "variable.csv"
   }
  ],
  "user": "username",
  "password": "ha16@sdharj21529aA==",
  "immediate": false,
  "disable_notifications": false,
  "region": "us-east-1",
  "browser": "opera",
  "suite_id": "5c9ca42171f823532163ef760",
  "suite_name": "buddy-tests",
  "folder_id": "5cd019551a5fads555105142",
  "channel": "slack_channel_name",
  "viewport": "5c9ca42171f8231b363ef760",
  "data_file": "$filePath",
  "start_url": "https://app.buddy.works/nickname",
  "user_agent": "usernameghost",
  "integration": {
    "id": 1
  }
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions/1",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1/action/1/edit",
  "id": 1,
  "name": "Ghost Inspector Action",
  "type": "GHOST_INSPECTOR",
  "trigger_time": "ON_EVERY_EXECUTION",
  "trigger_condition": "ALWAYS",
  "variables": [
   {
      "key": "filePath",
      "value": "variable.csv"
   }
  ],
  "user": "username",
  "password": "secure!eJ03wJFPIF+VUuGhrawiUWA==",
  "immediate": false,
  "disable_notifications": false,
  "region": "us-east-1",
  "browser": "opera",
  "suite_id": "5c9ca42171f823532163ef760",
  "suite_name": "buddy-tests",
  "folder_id": "5cd019551a5fads555105142",
  "channel": "slack_channel_name",
  "viewport": "5c9ca42171f8231b363ef760",
  "data_file": "$filePath",
  "start_url": "https://app.buddy.works/nickname",
  "user_agent": "usernameghost",
  "integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
    "html_url": "https://app.buddy.works/integrations",
    "id": 1
  },
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1",
    "id": 1,
    "name": "test server",
    "trigger_mode": "MANUAL",
    "ref_name": "master",
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.