Repository navigation
docs(alerts): email channels take several recipients - #823
Conversation
The Email page read as one address per channel, while the construct page documents comma-separated lists. The web app, public API and CLI all accept several addresses on one channel. Say how to enter them, that each alert is one email to all recipients, and how to change the recipients later. 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. |
hlenke
left a comment
There was a problem hiding this comment.
Ready to merge · The form behavior, the UI labels and the one-email-to-all-recipients claim match the web app and the alerting code on monorepo main. The construct page and the integration page now say the same thing.
CI is green and the PR merges cleanly. The only other open PR on these files is the draft #774 (sentence-case headings), which edits one line of constructs/email-alert-channel.mdx.
Inline comments: 1 wording (optional).
What I checked
- Read the whole diff and the full PR versions of
integrations/alerts/email.mdxand the options section ofconstructs/email-alert-channel.mdx(merge basee0e0277f; nothing onmainsince touches them). - Several addresses per channel in the web app, one entry per address: the Email channel form (
apps/webapp/src/pages/alert-channel-builder/channels/configs/email/EmailConfig.vue) uses a tag input, splits a pasted comma-separated list, validates each address ("Not a valid email address: …"), and stores the addresses joined by commas inconfig.address. That's the same shape the construct and the public API take. Enter adds an entry; Space and leaving the field do too, which the page doesn't need to mention. - Labels: Create email and Save email (
apps/webapp/src/constants/alert-channels.ts), Edit channel and Recipients on the channel details page (PageAlertChannelDetails*.i18n.ts). The details page lists the recipients by splitting the stored list. - Each alert is one email addressed to all recipients: the email alert channel passes the stored
config.addressas is as the recipient of one message (apps/backend/api/src/common/services/alert-notification-service/channels/email/index.ts). The PR description also lists a local alert whose outgoing request had one message to both addresses. - Example addresses use
acme.com, like the other examples on the construct page. gh pr checks 823: all pass.gh pr view: MERGEABLE / CLEAN.scripts/pr_impact.py: no cross-file findings.- End-to-end against local Checkly: not run. Source settled every claim, and the PR description lists local runs for each one.
- Could not verify, and left out of the review: whether one suppressed address stops delivery to the other recipients of the same email. The "Inactive addresses" troubleshooting section may be worth revisiting with that in mind.
| Owner, Admin and Read & Write members can create alert channels. Read & Run and Read Only members can't. | ||
| </Note> | ||
|
|
||
| To change the recipients of an existing email channel, open the channel from [Alert channels](https://app.checklyhq.com/alerts/settings). Its details page lists the **Recipients**. Click **Edit channel**, add or remove addresses, and click **Save email**. |
There was a problem hiding this comment.
Wording (optional): this paragraph and the new line 39 are both about a channel's recipients, but the roles <Note> sits between them. Moving this paragraph up to follow line 39 keeps the two together, and the Note then closes the setup section.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
What changed and why
The Email alert page read as if a channel holds one address ("Enter the email address. You can use an individual address or a distribution list."). The EmailAlertChannel construct page says a comma-separated list works. The product now supports several recipients on one email channel in the web app as well: the form takes each address as a separate entry and stores them as one comma-separated list, as the CLI and public API already do.
This PR:
integrations/alerts/email.mdx:constructs/email-alert-channel.mdx: keeps the comma-separated guidance, and adds an example and the same one-email note.How each claim was verified
Tested on a local Checkly stack built from the latest product code. Test addresses used the reserved
example.com,example.organdexample.netdomains.qa@example.net,sre@example.netand pressing Enter created two entries. After Create email, the storedconfig.addresswas the four addresses joined by commas.not-an-emailshowed "Not a valid email address: not-an-email" and disabled Test alert channelcheckly deploy --previewand thencheckly deploywithaddress: "ops@example.com, dev@example.org". The channel was created with that value.POST /v1/alert-channelswitha,band witha, b: 201, value stored unchangedops@example.com, dev@example.orgtriggered a real alert. The outgoing email request contained one message withTo: "ops@example.com, dev@example.org".Not tested / left out
🤖 Generated with Claude Code