Skip to content

docs(flaky-tests): document webhook event schemas with field descriptions#548

Draft
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/flaky-tests-webhook-event-schema-descriptions
Draft

docs(flaky-tests): document webhook event schemas with field descriptions#548
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/flaky-tests-webhook-event-schema-descriptions

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Documents the three Flaky Tests webhook event types now published to Svix: test_case.monitor_status_changed, v2.test_case.status_changed, and test_case.investigation_completed
  • Adds field-level reference tables showing each payload field, type, and description
  • Updates the Supported Events section of the Flaky Tests webhooks page

Source

Test plan

  • Preview in GitBook

…ions

PR #3519 added descriptive metadata to the three Flaky Tests webhook
event schemas published via Svix. Each event type now has per-field
descriptions visible in the Svix app portal.

Add reference tables for test_case.monitor_status_changed,
v2.test_case.status_changed, and test_case.investigation_completed
to the Flaky Tests webhooks page.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants