Read the Docs + GitHub: getting failure-only build alerts without the success noise
0 reputation · 19 Aug 2023, 06:47 UTC
0 reputation · 19 Aug 2023, 06:47 UTC
I have a Read the Docs project connected to a GitHub repository through the native webhook integration, so every push and pull request triggers a documentation build. Email notifications are enabled under Settings → Notifications, but that toggle appears to cover all build outcomes, so successful builds generate the same volume of mail as failures. My goal is to alert only when a build breaks, without routing every routine success through my inbox.
The dashboard does not seem to expose a failure-only option, while the API documentation hints that webhook notification behavior may be configurable per endpoint. It is unclear whether that parameter is available on the free community hosting tier or restricted to Read the Docs for Business. I would prefer to avoid an external filter (GitHub Actions, Zapier, or a relay script) because that adds latency and a failure point that could silently drop a critical alert. Assume a recent stable Read the Docs deployment; behavior may differ between plans, so answers should note which tier they apply to.
A thoughtful contribution can make all the difference. Be the first to share one.
Use comments to ask for clarification. Post a solution as an answer.
No question comments on this page.