https://docs.aviator.co/testdeck-beta/api-and-webhooks

No text content available for this version.

Location: In the "Request Body" section

Context: "Request Body Name Type Description org * String Organization name for the repo. repo * String Repository name. page Integer Page number github_check_name

*<<< String Name of the GitHub check"

Problem: The asterisk (*) marking for required fields is inconsistent. The "page" parameter doesn't have an asterisk, suggesting it's optional, but "github_check_name" has an asterisk suggesting it's required. However, for a general flaky test query, requiring a specific GitHub check name doesn't make sense - it should likely be optional to allow querying all flaky tests across all checks.

Fix: Remove the asterisk from "github_check_name" to make it consistent with "page" as an optional parameter, or add clear documentation about which fields are required vs optional.

Location: In the "Event payload" section

Context: "Example JSON payload for TestDeck webhook: Note:

commit_sha

is an optional field and will only be present when notifying about a

new_flaky_test

."

Problem: The documentation mentions an example JSON payload but doesn't actually show the JSON example. This leaves readers without a concrete example of what the webhook payload looks like.

Fix: Add the actual JSON payload example after "Example JSON payload for TestDeck webhook:" or remove the reference to an example if it's not meant to be included.

No product messaging analysis available for this page.

No competitive analysis available for this page.