Skip to content

Conversation

@mklocek
Copy link
Contributor

@mklocek mklocek commented Jan 28, 2026

Motivation

It's no longer needed, as we moved this info to knowledge base (https://docs.mailtrap.io/email-api-smtp/advanced/webhooks).

Changes

  • Remove webhooks spec

How to test

  • No testing needed. The specs were already removed in Gitbook.

Images and GIFs

None.

Summary by CodeRabbit

  • Documentation
    • Removed Webhooks specification from the repository, including the complete OpenAPI specification file and all references from documentation tables and guides.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 28, 2026

📝 Walkthrough

Walkthrough

This PR removes all references to the Webhooks specification from repository documentation files and deletes the entire webhook OpenAPI specification file. Changes affect four files across documentation and specification directories.

Changes

Cohort / File(s) Summary
Documentation Updates
CLAUDE.md, README.md, SUMMARY.md
Removed all Webhooks specification entries from documentation tables and sections—deletes spec references and YAML example blocks.
Specification File Removal
specs/webhooks.openapi.yml
Deleted entire OpenAPI 3.1.0 webhook specification file (725 lines), including API metadata, webhook endpoints, request/response schemas, code samples, and example payloads for events and activity logs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • PR #13: Modifies metadata within specs/webhooks.openapi.yml file, whereas this PR completely removes the same file.

Suggested reviewers

  • leonid-shevtsov
  • IgorDobryn
  • yanchuk

Poem

🐰 A webhook once lived in our specs,
With payloads and endpoints complex,
But time moves along,
So we bid it goodbye with this song—
The docs now are tidied, all checks!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: removing the webhooks specification from the repository.
Description check ✅ Passed The pull request description follows the required template with all major sections completed: Motivation explains why (moved to knowledge base), Changes lists the action, and How to test is addressed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mklocek mklocek merged commit 1641d4c into main Jan 28, 2026
2 checks passed
@mklocek mklocek deleted the MT-20455-remove-webhooks-section branch January 28, 2026 10:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants