Ask or search…
K
Links

API and Webhooks

API

get
https://api.aviator.co/api/v1/testdeck
/flaky
Get flaky tests in the last 30 days.
The flaky test API can be used to fetch the results of all flaky tests in the last 30 days. The results are paginated with maximum of 100 results returned in the response. The results are in the order of the most recent flaky, based on first_occurrence.
Parameters
Body
org*
String
Organization name for the repo.
repo*
String
Repository name.
github_check_name*
String
Name of the GitHub check
page
Integer
Page number
Responses
200: OK

Webhooks

Aviator already supports a webhook framework that lets you listen to various events. By using Aviator’s new capabilities to detect flaky tests, you can now subscribe to these flaky test webhooks to take actions based on the event payload.

Event payload

Example JSON payload for TestDeck webhook:
{
"action": "new_flaky_test",
"repository": {
"name": "repo_name",
"org": "repo_org"
},
"test_suite": {
"name": "ci/circleci: unit-tests",
"provider": "CircleCI"
},
"test_case": {
"name": "test_invalid_security_code",
"class_name": "core.payments.SecurityCodeTest",
"first_occurrence": "2022-11-16T17:21:41.350499",
"last_occurrence": "2022-11-18T11:13:23.12361",
"last_24_hours_count": 5
},
"commit_sha": "c576a61d26f72ad335660bdaefa4d63306c5752c"
}
Note: commit_sha is an optional field and will only be present when notifying about a new_flaky_test.

Event actions

You can subscribe to these specific actions for webhooks.
  • new_flaky_test - a new flaky test is found.
  • resolved_flaky_test - when an existing flaky test has not been identified as flaky in the last 14 days