Skip to main content
BrowserStack
Previewv0.2.0
216 actions · 7 events · 3 auth methods
Developer ToolsIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Key · Connector Profile

No app registration required. Uses the username and access key of an Owner or Group Admin, and acts with that member’s r…

Access Key · Connector Profile

Uses only the access key, sent as the auth_token query parameter. Covers the Local Testing actions only.

Percy Project Token · Connector Profile

Scoped to one Percy project. Covers the Percy read actions only; approving, rejecting and deleting builds need the API K…
Optionally, configure receiving Events for BrowserStack into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Key · Link Account

Access Key · Link Account

Percy Project Token · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
216 actions
Action
Description
Get Accessibility Build List
List Accessibility Testing builds run by Automated tests, with basic details for each build.
Get Build Report Summary
Get a high-level accessibility summary for one Automated tests build, such as score and issue counts.
Get Build Report Issues
Get the issue export for an Accessibility Testing Automated tests build, including a CSV report_link.
Get Test Case List
List the test cases run in one Accessibility Testing Automated tests build, with basic details for each.
Get Test Case Report Summary
Get a high-level accessibility summary for one test case in an Automated tests build.
Get Test Case Report Issues
Get the issue export for one test case in an Accessibility Testing Automated tests build, including a CSV report_link.
Compare Build Issues
Compare the accessibility issues of two Automated tests builds of the same project.
Get Assisted Test Report List
List Accessibility Testing reports created by Assisted tests, with basic details for each report.
Get Assisted Test Report Summary
Get a high-level summary of one Accessibility Testing Assisted tests report, such as score and issue counts.
Get Assisted Test Report Issues
Get the issue export for an Accessibility Testing Assisted tests report, including a CSV report_link.
Get Workflow Analyzer Report List
List Accessibility Testing reports created by Workflow Analyzer, with basic details for each report.
Get Workflow Analyzer Report Summary
Get a high-level summary of one Accessibility Testing Workflow Analyzer report.
Get Workflow Analyzer Report Issues
Get the issue export for an Accessibility Testing Workflow Analyzer report, including a CSV report_link.
Get Scan List
List the scans set up in the Accessibility Testing Website Scanner, with basic details for each scan.
Get Scan Details
Get the configuration overview and URL list of one Accessibility Testing Website Scanner scan.
Get Scan Run List
List the runs of one Accessibility Testing Website Scanner scan.
Get Scan Run Summary
Get the summary of one Accessibility Testing Website Scanner scan run, such as score and issue counts.
Get Scan Run Status
Get the status of one Accessibility Testing Website Scanner scan run.
Get Scan Run Issues
Get the issue export for one Accessibility Testing Website Scanner scan run, including a CSV report_link.
Create Scan
Create a one-time or recurring Accessibility Testing Website Scanner scan.
Trigger Scan Run
Start a new run of an existing Accessibility Testing Website Scanner scan.
List Scan Auth Configs
List the authentication configs available to Website Scanner scans.
Create Scan Auth Config
Create a basic or form login config for Website Scanner scans.
Get Device List
List the real Android and iOS devices available for Appium tests on App Automate.
Get App Automate Plan Details
Get the App Automate plan with its parallel limits and live running and queued counts.
Monitor Parallel And Queue Usage Details
Get real-time App Automate parallel and queue usage broken down by team and member.
List Uploaded Apps
List apps recently uploaded for Appium testing on App Automate.
Upload An App Automate App
Upload an Android or iOS app from a public URL for Appium testing on App Automate.
Delete An App
Permanently delete an app uploaded for Appium testing on App Automate.
List Recent App Automate Builds
List recent Appium builds on App Automate.
Get App Automate Build Details
List the test sessions run under an Appium build on App Automate.
Get Text Logs
Get the text logs of an Appium session on App Automate.
Get Device Logs
Get the device logs of an Appium session on App Automate.
Get Crash Logs
Get the crash logs of an Appium session on App Automate.
Update Build Details
Rename a finished Appium build on App Automate, or set or remove its build tag.
Delete An App Automate Build
Permanently delete an Appium build and all its sessions on App Automate.
Get Appium Logs
Get the Appium server logs of an App Automate session.
Get Network Logs
Get the network logs of an App Automate session in HAR format.
List Recent Espresso Builds
List recent Espresso builds on App Automate.
Get Espresso Build Status
Get the status of an Espresso build on App Automate with its per-device sessions and test case counts.
Get Espresso Session Details
Get an Espresso session on App Automate with per-test-case results and log URLs.
Upload An Espresso App
Upload an Android app from a public URL for Espresso testing on App Automate.
Upload An Espresso Test Suite
Upload an Espresso test suite (.apk) from a public URL to App Automate.
Execute An Espresso Build
Start an Espresso test build on App Automate on the selected devices.
Stop An Espresso Build
Stop a running Espresso build on App Automate.
Delete Espresso App
Delete an uploaded Espresso app from App Automate.
Delete Espresso Test Suite
Delete an uploaded Espresso test suite from App Automate.
List Recent Projects
List recent Appium projects on App Automate.
Get App Automate Project Details
Get an App Automate project and the builds run under it.
Get App Automate Session Details
Get the details of an Appium session on App Automate.
Update Session Status
Mark an Appium session on App Automate as passed or failed, or rename it.
Delete A Session
Permanently delete an Appium session on App Automate.
List Recent XCUITest Builds
List recent XCUITest builds on App Automate.
Get XCUITest Build Status
Get the status of an XCUITest build on App Automate with its per-device sessions and test case counts.
Get XCUITest Session Details
Get an XCUITest session on App Automate with per-test-case results and log URLs.
Upload An XCUITest App
Upload an iOS app (.ipa) from a public URL for XCUITest testing on App Automate.
Upload An XCUITest Test Suite
Upload an XCUITest test suite (.zip) from a public URL to App Automate.
Execute An XCUITest Build
Start an XCUITest build on App Automate on the selected iOS devices.
Stop An XCUITest Build
Stop a running XCUITest build on App Automate.
Delete XCUITest App
Delete an uploaded XCUITest app from App Automate.
Delete XCUITest Test Suite
Delete an uploaded XCUITest test suite from App Automate.
List Audit Logs
List the audit log events of the BrowserStack organization account between two dates.
Get Audit Activity Types
List the activity types that BrowserStack Enterprise audit logs record, grouped by category.
Get Browser List
List every OS, browser, browser version and real device combination supported by BrowserStack Automate.
Get Automate Plan Details
Get the Automate plan with its parallel session limit and current running and queued sessions.
Get Automate Build List
List recent Automate builds.
Get Automate Build Details
Get an Automate build with up to 100 of its recent sessions.
Get Session List
List the sessions of an Automate build.
Update Build Details / Build Tags
Rename a finished Automate build or set or remove its build tag.
Delete An Automate Build
Permanently delete an Automate build and all its sessions.
Get Automate Project List
List the Automate projects for the account.
Get Automate Project Details
Get an Automate project and its builds.
Get Automate Session Details
Get an Automate session with its status, environment and log and video URLs.
Get Session Text Logs
Get the text log of an Automate session with all its requests and responses.
Get Session Network Logs
Get the network logs of an Automate session in HAR format, for sessions run with network logs enabled.
Get Session Console Logs
Get the raw browser console logs of an Automate session (Chrome only).
Set Test Status / Update Session Name
Mark an Automate session as passed or failed with a reason, or rename it.
Delete Session
Permanently delete an Automate session.
Get Unified Credentials
Get the current BrowserStack connection’s unified credentials and identity.
List Unified Groups
List the teams of a BrowserStack organization account as unified groups.
Get Unified Group
Get a unified BrowserStack team by ID.
List Unified Roles
List the built-in user roles of BrowserStack.
Get Unified Role
Get a built-in BrowserStack user role by ID.
List Unified Users
List unified users in a BrowserStack organization account.
Get Unified User
Get a unified BrowserStack user by ID.
List IAM Projects
List the BrowserStack organization projects you can view.
Get IAM Project Details
Get one BrowserStack organization project by its PR identifier.
Get Project Access List
List the users, teams and service accounts with explicit access to a BrowserStack organization project.
Create An IAM Project
Create a BrowserStack organization project and enable products on it.
Update An IAM Project
Update the name, description, access level or products of a BrowserStack organization project.
Delete An IAM Project
Permanently delete a BrowserStack organization project and all its data.
Archive A Project
Archive a BrowserStack organization project.
Unarchive A Project
Restore an archived BrowserStack organization project.
Transfer Project Ownership
Transfer a BrowserStack organization project to a new owner or move it to another team.
Grant/Replace Project Access
Grant access to a BrowserStack organization project or change the project roles of its accessors.
Revoke Project Access
Remove access to a BrowserStack organization project from users, teams or service accounts.
Poll Run Status
Get the state of a BrowserStack Load Testing run.
Fetch Run Report
Get the final report of a BrowserStack Load Testing run.
Trigger A Load Test Run
Start a saved BrowserStack Load Testing test by project and test name.
Stop A Run
Stop an in-progress BrowserStack Load Testing run.
List Local Testing Binary Instances
List BrowserStack Local Testing binary instances, by default only the running ones.
Get A Local Testing Binary Instance
Get one BrowserStack Local Testing binary instance by ID.
Stop A Local Testing Binary Instance
Disconnect a running BrowserStack Local Testing binary instance.
List Builds
List the builds in a Low Code Automation project.
Get Build
Get one Low Code Automation build with its test runs and its accessibility and visual testing results.
Get Test Run
Get one test run of a Low Code Automation build with its attempts, steps, artifacts and bug details.
Get Low Code Build Status
Get the status and execution summary of a Low Code Automation build.
Get Build Report
Get the XML report of a Low Code Automation build in the format of a test management tool.
Rerun Failed Tests
Queue a rerun of the failed tests in a Low Code Automation build.
File A Bug For A Test Run
File a bug in a connected Jira or Azure DevOps tracker and link it to a Low Code Automation test run.
List Low Code Projects
List the Low Code Automation projects your group owns.
Get Project
Get one Low Code Automation project with its description.
List Test Suites
List the test suites in a Low Code Automation project.
Get Test Suite
Get the full configuration of one Low Code Automation test suite.
Trigger A Test Suite Run
Start a run of a Low Code Automation test suite.
List Tests
List the recorded tests in a Low Code Automation project.
Get Test
Get one recorded Low Code Automation test with its steps, variables, dataset and versions.
List Recent Percy Builds
List Percy builds from the last 30 days, with optional commit SHA, branch and state filters.
Get Percy Build Details
Get one Percy build, optionally with its build summary.
Approve, Unapprove Or Reject A Build
Approve, unapprove or reject a Percy build.
Delete A Percy Build
Delete a Percy build.
Get Percy Project Details
Get Percy project details, such as ID, slug, settings and browser targets.
List Snapshots
List the snapshots of one Percy build, with optional review state, ID and name filters.
Get Snapshot
Get one Percy snapshot with its comparisons, screenshots, images and comparison tags.
List Available OS And Browser Combinations
List the OS, browser and device combinations available to BrowserStack Screenshots.
Get Screenshot Job Status And Image URLs
Get a BrowserStack Screenshots job with the state and image URLs of each screenshot.
Create A Screenshot Job
Start a BrowserStack Screenshots job that captures a URL on a set of OS and browser combinations.
List Service Accounts
List the service accounts of the BrowserStack organization account without their access keys.
Create Service Account
Create a BrowserStack Enterprise service account for the organization or for one team.
Delete Service Account
Delete a BrowserStack Enterprise service account.
List Teams
List the teams of the BrowserStack organization account with their members.
Get Team
Get one BrowserStack team by name, with its members.
Create Team
Create a team in the BrowserStack organization account.
Delete Team
Delete a team from the BrowserStack organization account.
Allocate Parallels To Team
Set how many Automate or App Automate tests each BrowserStack team can run in parallel.
Allocate Licenses To Teams
Set how many Live or App Live licenses each BrowserStack team gets.
Get Configurations
List the system and custom Test Management configurations, which are OS, browser and device combinations.
Get Configuration By ID
Get one system or custom Test Management configuration by its ID.
Get Custom Fields
List the custom fields configured for Test Management test cases and test results.
Get List Of Folders
List the root-level folders of a Test Management project.
Get Folder Details
Get one folder in a Test Management project.
Create A Folder
Create a folder in a Test Management project, at the root or inside another folder.
Update A Folder
Rename a Test Management folder or change its description.
Delete A Folder
Permanently delete a folder from a Test Management project.
Get Test Management Project List
List the Test Management projects the account can access.
Get Test Management Project Details
Get one Test Management project by its identifier.
Create A Test Management Project
Create a Test Management project.
Update A Test Management Project
Rename a Test Management project or change its description.
Delete A Test Management Project
Permanently delete a Test Management project.
Global Test Case Search
Search Test Management test cases by text across every project the account can access.
Get Allowed Reviewers Of A Project
List the users allowed to review test cases in a Test Management project.
Get List Of Test Cases
List and filter the test cases in a Test Management project.
Get A Test Case
Get one Test Management test case by its identifier.
Get Comments Of A Test Case
List the comments on a Test Management test case.
Create A Test Case
Create a standard or BDD test case in a Test Management folder.
Assign Reviewers To Multiple Test Cases
Add, remove or replace reviewers and set the review status on many Test Management test cases at once.
Bulk Create Test Cases
Create up to 10,000 Test Management test cases in one folder with a single call.
Update A Test Case
Update the fields, steps, tags or reviewers of one Test Management test case.
Bulk Edit Test Cases
Apply the same field changes to many Test Management test cases at once. The response only confirms the request, and the…
Delete A Test Case
Permanently delete one Test Management test case.
Archive A Test Case
Archive a Test Management test case so it is hidden but not deleted.
Unarchive A Test Case
Restore an archived Test Management test case to active.
Move A Test Case
Move one Test Management test case to another folder in the same project.
List Sub Test Plans
List the sub test plans of a Test Management test plan.
Get List Of Test Plans
List the test plans in a Test Management project.
Get Test Plan Details
Get one Test Management test plan with its linked test runs.
Get Test Runs Linked To A Test Plan
List the test runs linked to a Test Management test plan.
Create Test Plan
Create a test plan in a Test Management project.
Update Test Plan
Update the name, status, description or dates of a Test Management test plan.
Get Sub Test Plan
Get one sub test plan of a Test Management test plan.
Create Sub Test Plan
Create a sub test plan under a Test Management test plan.
Update Sub Test Plan
Update the name, description, dates or status of a sub test plan.
Delete Sub Test Plan
Delete a sub test plan from a Test Management test plan.
Get All Test Results For A Test Run
List every test result recorded in a Test Management test run.
Get Results For A Test Case In A Run
List the results of one test case within one Test Management test run.
Get Results For A Test Case Across Runs
List the results of one Test Management test case across all test runs.
Add Test Result(s) To A Test Run
Record one or many test results, with optional step results, in a Test Management test run.
Update A Test Result
Change the status, notes or custom fields of a recorded Test Management test result.
Get Test Runs List
List and filter the test runs in a Test Management project.
Get Test Run Details
Get one Test Management test run with its state, progress counts, configurations and test cases.
Get Test Cases Of A Test Run
List and filter the test cases in a Test Management test run with their latest status and assignee.
Create A Test Run
Create a test run in a Test Management project.
Clone A Test Run
Create a new Test Management test run by copying an existing manual run.
Update A Test Run
Change the name, state, tags, sub test plan, configurations or test cases of a Test Management test run.
Update Assignee Of Test Cases In A Run
Assign specific test cases in a Test Management test run to testers, optionally per configuration.
Add Or Remove Test Cases In A Test Run
Add test cases to, or remove them from, a Test Management test run.
Close A Test Run
Close a Test Management test run.
Delete A Test Run
Delete a Test Management test run.
Get Test Reporting Build List
List the build runs of one Test Reporting & Analytics project, with optional filters.
Get Test Reporting Build Details
Get the summary of one Test Reporting & Analytics build run.
Get Latest Build Details
Get the latest build run of a Test Reporting & Analytics project, with optional filters.
Get Self-Healing Report
Get a download link for the self-healing report of one Test Reporting & Analytics build run.
Get Quality Gate Status Of A Build
Get the Quality Gate status of one Test Reporting & Analytics build run.
Get Tests
List the test runs of one Test Reporting & Analytics build run, with their results.
Update Build Metadata
Add build tags to a completed Test Reporting & Analytics build run.
Delete A Test Reporting Build
Permanently delete one Test Reporting & Analytics build run and its test results.
Get Automation Coverage
Get the automation coverage of one Test Reporting & Analytics project.
Get Test Reporting Project List
List Test Reporting & Analytics projects with their metadata.
Get User Report Job Status
Check the status of a BrowserStack Enterprise user usage report job.
Get User Usage Report
Get a finished BrowserStack Enterprise usage report per user.
Get Team Report Job Status
Check the status of a BrowserStack Enterprise team usage report job.
Get Team Usage Report
Get a finished BrowserStack Enterprise usage report per team.
Create User Usage Report Job
Start a job that builds a BrowserStack Enterprise usage report per user.
Create Team Usage Report Job
Start a job that builds a BrowserStack Enterprise usage report per team.
List Users
List the users of the BrowserStack organization account, with role, teams and product access.
Get User
Get one BrowserStack user by email address.
Get Account Owner
Read the Owner of the BrowserStack organization account.
Create User
Add a user to the BrowserStack organization account without sending an invitation.
Add Product Access
Give a BrowserStack user access to a product.
Revoke Product Access
Remove a BrowserStack user’s access to a product.
Update User Email
Change the email address of a BrowserStack user.
Update User Role
Change the role of a BrowserStack user.
Update User Team
Change the primary team of a BrowserStack user and optionally assign additional teams.
Disable User
Revoke all access of a BrowserStack user while keeping the user in the account.
Enable User
Restore the access and role a disabled BrowserStack user had before.
Delete User
Revoke all access of a BrowserStack user and delete the user from the account.

Events

|
7 events
Event
Description
Tags
Percy Webhook Ping
Answers the Percy ping sent when a webhook configuration is created or updated, and emits it as an event.
Health Checks
Percy Build Created
Processes Percy build_created events, fired when a new Percy build is created.
Percy
Percy Build Finished
Processes Percy build_finished events, fired when a Percy build finishes processing.
Percy
Percy Build Approved
Processes Percy build_approved events, fired when a build is approved by a team member, an auto-approve branch rule, or…
Percy
Percy Build Changes Requested
Processes Percy build_changes_requested events, fired when a build moves from Unreviewed to Changes requested.
Percy
Percy Build Unreviewed
Processes Percy build_unreviewed events, fired when a build moves from Changes requested back to Unreviewed.
Percy
BrowserStack Platform Webhook Event
Processes BrowserStack platform webhooks (Automate, App Automate, Test Reporting & Analytics and Test Management) sent w…
Webhooks