Skip to main content
POST
/
run
cURL
curl --request POST \
  --url https://api.qa.tech/v1/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actor": "<string>",
  "branch": "<string>",
  "commitHash": "<string>",
  "commitMessage": "<string>",
  "repository": "<string>",
  "testPlanShortId": "<string>",
  "applications": [
    {
      "applicationShortId": "<string>",
      "environment": {
        "url": "<string>",
        "name": "<string>"
      },
      "devicePresetShortId": "<string>"
    }
  ],
  "notifications": [
    {
      "type": "slack",
      "channel": "<string>"
    }
  ]
}
'
{
  "success": true,
  "run": {
    "id": "<string>",
    "shortId": "<string>",
    "url": "<string>",
    "testCount": 123,
    "testPlan": {
      "name": "<string>",
      "shortId": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Project API token from Settings > Integrations > API. The token is scoped to a specific project.

Body

application/json
​
trigger
enum<string>
Available options:
API,
GITHUB
​
actor
string
​
branch
string
​
commitHash
string
​
commitMessage
string
​
repository
string
​
testPlanShortId
string
Pattern: ^pln(-.+_.+|_.+)$
​
applications
object[]
​
notifications
object[]

Response

The request has succeeded.

​
success
boolean
required
​
run
object
required