Repository navigation
docs(alerts): SMS and phone call quotas, test limits and failed alerts - #815
Conversation
…ed alerts Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
…re quota Lists the specific notification results for failed SMS and phone call alerts with a fix for each, says the trial/Hobby test limit resets after 24 hours, and adds a contact-support line for more SMS or calls. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Tested on an Enterprise account: the third test within a minute returns 429 and the web app shows 'Test rate limit exceeded'; a test after 60 s passes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
hlenke
left a comment
There was a problem hiding this comment.
Needs changes · All claims check out against source and the pricing page. Move the new rejection-messages table on the SMS page below the country list, which it now splits from its lead sentence.
The content is accurate: every message string, quota result, and test limit matches the backend and webapp source, and the corrected Starter claim on the phone call page is right. One layout fix and two optional wording fixes are inline.
CI passes, it's mergeable, and main hasn't changed either file since the merge base. No other open PR touches these two pages.
Sibling consistency (optional): the SMS page gets its own ## Test messages section. The phone call page puts the same test-limit text in the last paragraph of ## Monthly phone call quota. Consider giving the phone call page a matching ## Test calls section, so readers find the test limit in the same place on both pages.
Inline: 0 blockers, 1 important, 2 wording.
What I checked
- Read the whole diff from merge base
e0e0277f:integrations/alerts/sms.mdx(+34) andintegrations/alerts/phone-calls.mdx(+21/-1). Read both pages in full at the PR head, including their heading outlines. gh pr checks 815: all pass.gh pr view: MERGEABLE / CLEAN.git log e0e0277f..origin/main: nothing new onmain.pr_impact.py: no findings.git greponmainfor other pages that state phone call plan availability: onlyphone-calls.mdx:20, which this PR corrects.- Pricing: https://www.checklyhq.com/pricing/ lists phone alerts as Hobby 0, Starter 0, Team 200/month and Enterprise custom, and SMS as Hobby 0, Starter 100/month and Team 200/month. This supports "Phone call alerts are included on the Team plan and above" and the Starter behavior.
- Quota results: monorepo
apps/backend/api/src/common/services/alert-notification-service/AlertNotificationService.ts(origin/main@84921d2637). SMS and call sends check the account's monthly metered amount and fail each channel's notification withAccount hit the monthly SMS limit/Account hit the monthly CALL limit. A missing quota counts as 0, so Starter calls fail. The metered amount grows by the number of channels. - SMS failure results:
channels/sms/SmsAlertChannel.tsreturnsRegion not enabled,Invalid phone number,Phone number doesn't support SMS,Attempt to send to unsubscribed recipient,FROM number not associated with Twilio account,Incomplete alert channel configandFailed to send the SMS. Call failure results:channels/call/index.tsreturnsIncomplete alert channel configandFailed to send the Call.InvocationResult.internalFailurestores the message as the result, so these strings are what the log shows. - Rejection messages: API:
common/services/phone-number-checker.ts,decorators/authorization/policies/enforceAlertChannelCountryTier.tsandmodules/public-api/projects/resources/alert-channel.ts. Web app:alert-channel-builder/channels/configs/sms/SmsConfig.vueand.../call/PhoneCallConfig.vue, which includesCalls to this country require a paid plan…. All strings match. The webapp'sInvalid country code…message ends with a period; the table omits it, which is harmless. - Test limits:
modules/alert-channels/run-test-helpers.tsapplies a token bucket only to Hobby and trial accounts, only for SMS and CALL tests (plus email tests to several recipients), and answers 429Alert channel test rate limit exceededwithRetry-After.modules/alert-channels/routes.tsandapp-config/default.tsset a route limiter of 2 requests per 60 s on the test endpoint for all plans. The webapp toast title isTest rate limit exceeded(PageAlertChannelBuilder.vue). - Local app unavailable (BUSY), so I verified against source. I didn't rerun the PR author's local scenarios.
| When a number is rejected, the channel form or the API tells you why: | ||
|
|
||
| | Message | What to do | | ||
| | ------ | ------ | | ||
| | `The number field must be a valid phone number` (web app) or `phoneNumber is not a valid phone number` (API) | Enter the number in E.164 format: a `+`, the country code and the number, without spaces or dashes. | | ||
| | `Invalid country code. Please see our documentation for a full list of supported countries` | Start the number with `+` and the country code, and use a country from the table below. | | ||
| | `SMS to this country requires a paid plan. Upgrade your plan to use this number.` (web app) or `SMS and phone call alerts to this country are only available on a paid plan. Upgrade your plan to use this number.` (API) | The country is available on paid plans only, not on trials. | | ||
| | `Adding or changing SMS and phone call alert channels requires the Starter plan or above.` (API) | Your account is on the Hobby plan, which doesn't include SMS alerts. | |
There was a problem hiding this comment.
Important: this table lands between "SMS alerts can only be sent to phone numbers in the following countries." (line 24) and the country table it introduces (line 35). The lead sentence now points at the wrong table, and the country list, which is what readers open this section for, moves down. Move lines 26–33 below the country table, before ## SMS alert number and sender ID. In the second row, change "use a country from the table below" to "the table above".
There was a problem hiding this comment.
correct. lets apply these changes
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
What changed and why
The SMS and phone call pages said that sends count against a monthly quota and pointed to the pricing page, but didn't say what happens when the quota runs out, where to see it, how test messages behave, or why a phone call channel on Starter never calls. This PR adds that, and corrects one existing claim.
integrations/alerts/sms.mdxFailed,Account hit the monthly SMS limit). Quota numbers stay on the pricing page.429withAlert channel test rate limit exceeded).integrations/alerts/phone-calls.mdxAccount hit the monthly CALL limitbecause Starter includes no phone calls. Hobby accounts can't create the channel.Account hit the monthly CALL limit, and the daily test-call limit on trials, which resets after 24 hours. A line to contact support for more.Only the body text changes; the frontmatter lines that #774 touches are untouched. No overlap with #811 (Slack) or #812 (alerts overview).
How each claim was verified
Local stack at monorepo
origin/main(e086a77755): API, results and alerting daemons, go-runner, web app. Plan fixture accounts (Hobby, Starter, Team, Trial, Contract) seeded by the devenv; real API check runs triggered real alerts.POST(public and internal) →402Adding or changing SMS and phone call alert channels requires the Starter plan or above.; web app shows both tiles disabled with a Starter badge201/200; web app opens and offers the phone call form with Test alert channelFAILURE,Account hit the monthly CALL limit; SMS was attempted. Starter's 0-call allowance is on the public pricing page+49 151 …and+49-151-…and over-long numbers →phoneNumber is not a valid phone number;0049…,49…(no+) and+7…→Invalid country code…. Web app: same inputs showThe number field must be a valid phone numberandInvalid country code…402with the paid-plan message for SMS and CALL; web app showsSMS to this country requires a paid plan…andCalls to this country require a paid plan…. Team fixture: same number acceptedFAILUREwithAccount hit the monthly SMS limit/…CALL limit; shown in the web app notification log as Delivery status: Failed and Notification result429Alert channel test rate limit exceededafter the allowance, for SMS and CALL; Starter and Team not limited by it. Web app (trial): after the allowance the button turns into Wait …s, for SMS and phone calls429with aRetry-Afterof about 24 hours; config: refill interval86_400_000ms (alertChannelTestBucketRefillIntervalMs, monorepoorigin/main796988bcda)Invalid phone number,Phone number doesn't support SMS,Region not enabled,Attempt to send to unsubscribed recipient,Incomplete alert channel config,FROM number not associated with Twilio account,Failed to send the SMSSmsAlertChannel.ts(handleSmsError,sendAlert) onorigin/main796988bcda. Meanings and fixes from the provider's public error pages for the mapped codes (21211, 21614, 21408, 21610: opt back in by textingSTART)Incomplete alert channel config,Failed to send the Callchannels/call/index.tssendCallAlertonorigin/main; calls have no more specific alert resultsPOST /accounts/{id}/alert-channels/test→ 200, 200, 429, 429; toast Test rate limit exceeded, responseRate limit exceeded. A test 65 s later → 200alert-channels/routes.ts,alertChannelTestRequests2 peralertChannelTestDuration60 s,origin/main796988bcda), keyed by user, not by channel type. Tested with a webhook channel onlyNot tested, or left out
origin/main).now(), and the production database time zone isn't set in code (RDS is managed outside Terraform). Left at "calendar month".🤖 Generated with Claude Code