Visual tests

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to VISUAL_TESTS.

browser_typerequired string

Defines which browser will be used in tests. Can be one of CHROME or FIREFOX.

resolution_widthrequired integer

Resolution width.

resolution_heightrequired integer

Resolution height.

pixel_tolerance_levelrequired float

The acceptable level of pixel tolerance. Allowed number of decimal places is two.

images_history_limitrequired integer

The number of items that should be kept in history.

screenshotsrequired Screenshot[]

Defines the URLs of the sites that will be tested. Contains information about baseline, headers and excluded areas.

headersHeader[]

The headers that will be sent with the request.

permissionsPipelinePermissions

Define to set permissions for the action.

Last modified on Sep 27, 2024

Upcloud (Private key & password)Vultr (Password)

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Visual Tests",
  "type": "VISUAL_TESTS",
  "headers": [
    {
      "name": "header1",
      "value": "value1"
    },
    {
      "name": "header2",
      "value": "value2"
    }
  ],
  "browser_type": "CHROME",
  "resolution_width": 1920,
  "resolution_height": 1080,
  "pixel_tolerance_level": 1.23,
  "images_history_limit": 30,
  "screenshots": [
    {
      "url": "https://buddy.works/",
      "baseline": "https://buddy.works/",
      "headers": [
        {
          "name": "header1",
          "value": "value1"
        },
        {
          "name": "header2",
          "value": "value2"
        }
      ],
      "excluded_areas": [
        {
          "min_x": 200,
          "min_y": 100,
          "max_x": 500,
          "max_y": 200
        }
      ]
    }
  ]
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
  "id": 2,
  "name": "Visual Tests",
  "type": "VISUAL_TESTS",
  "headers": [
    {
      "name": "header1",
      "value": "value1"
    },
    {
      "name": "header2",
      "value": "value2"
    }
  ],
  "browser_type": "CHROME",
  "resolution_width": 1920,
  "resolution_height": 1080,
  "pixel_tolerance_level": 1.23,
  "images_history_limit": 30,
  "screenshots": [
    {
      "url": "https://buddy.works/",
      "baseline": "https://buddy.works/",
      "headers": [
        {
          "name": "header1",
          "value": "value1"
        },
        {
          "name": "header2",
          "value": "value2"
        }
      ],
      "excluded_areas": [
        {
          "min_x": 200,
          "min_y": 100,
          "max_x": 500,
          "max_y": 200
        }
      ]
    }
  ],
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "test server",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999