Notifications
How SpecVault sends email alerts when breaking changes are detected, and how to configure your SMTP settings.
When alerts fire
SpecVault sends an email alert every time a new spec version is published and the diff against the previous version contains at least one breaking change. Additive-only changes (new endpoints, new optional fields) do not trigger alerts.
Each subscriber on the affected service receives one email per publish event. If a publish has no breaking changes, no email is sent.
Alert email format
The alert email contains:
- Subject:
[SpecVault] Breaking changes in <Service Name> v<version> - Service name and the version number that introduced the changes
- Publish timestamp and the publisher's email
- A numbered list of each breaking change, including the HTTP method, path, and a plain-English description (e.g. Required parameter "user_id" removed from GET /users)
- A direct link to the diff detail page in the SpecVault dashboard
- An unsubscribe link for that specific service
Email delivery
Email delivery is fully managed — there is no SMTP server to configure. SpecVault sends alerts from a SentinelFlux-managed sending domain, so there's nothing to set up on your side. Just add subscriber addresses to a service and alerts start flowing on the next breaking change.
If an alert doesn't arrive
Every breaking-change publish is recorded in the audit log with an alert.sent event and the recipient count, so you can always confirm whether an alert was dispatched. If a subscriber says they didn't receive one:
- Check the subscriber's spam or quarantine folder, and allowlist the SpecVault sending domain.
- Confirm the subscriber address is spelled correctly on the Subscribers tab.
- Confirm the publish actually contained a breaking change — additive-only changes don't trigger alerts.
If alerts are confirmed sent in the audit log but consistently aren't delivered, contact engage@sentinelflux.in.
Breaking changes are always detected and shown in the dashboard diff view regardless of email delivery, so you never lose visibility even if an inbox bounces.
Unsubscribe flow
Every alert email includes a one-click unsubscribe link. Clicking it removes the subscriber from that specific service only; they remain subscribed to any other services. Admins can also remove subscribers directly from the Subscribers tab in the dashboard.