Skip to content

docs(alerts): email channels take several recipients - #823

Merged
hlenke merged 2 commits into
mainfrom
docs/email-channel-recipients
Nov 10, 2026
Merged

hlenke merged 2 commits into
mainfrom
docs/email-channel-recipients

Conversation

@hlenke

@hlenke hlenke commented Nov 9, 2026

Copy link
Copy Markdown
Member

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:
    • Step 3 now says you can enter one or more addresses: press Enter after each one, or enter a comma-separated list.
    • Adds that each alert is sent as one email addressed to all of the channel's recipients.
    • Adds how to change the recipients of an existing channel: open it from Alert channels, then Edit channel and Save email.
  • 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.org and example.net domains.

Claim How it was verified
The web app form takes several addresses, one per Enter Added two addresses in the new Email channel form, and each became its own entry
A comma-separated list is split into separate addresses Typing qa@example.net,sre@example.net and pressing Enter created two entries. After Create email, the stored config.address was the four addresses joined by commas.
Invalid addresses are flagged in the web app Adding not-an-email showed "Not a valid email address: not-an-email" and disabled Test alert channel
The construct accepts a comma-separated list CLI 10.1.0: checkly deploy --preview and then checkly deploy with address: "ops@example.com, dev@example.org". The channel was created with that value.
The public API accepts a list (no change to the API docs) POST /v1/alert-channels with a,b and with a, b: 201, value stored unchanged
Each alert is one email addressed to all recipients A failing API check subscribed to a channel with ops@example.com, dev@example.org triggered a real alert. The outgoing email request contained one message with To: "ops@example.com, dev@example.org".
Changing recipients: open the channel, Edit channel, Save email The channel's details page lists Recipients and has Edit channel. Removing one address and clicking Save email showed "Alert channel updated successfully", and the stored list dropped that address.

Not tested / left out

  • Delivery to the inboxes themselves can't run locally. The tests stop at the request sent to the email provider, so the docs describe what Checkly sends, not inbox delivery.
  • Left out pending product decisions:
    • separators other than commas;
    • address validation in the CLI and API;
    • limits on test notifications sent to several recipients.

🤖 Generated with Claude Code

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>
@mintlify

mintlify Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Nov 10, 2026, 12:57 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.mdx and the options section of constructs/email-alert-channel.mdx (merge base e0e0277f; nothing on main since 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 in config.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.address as 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.

Comment thread integrations/alerts/email.mdx Outdated
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**.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do that change

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@hlenke
hlenke merged commit 8ece9c6 into main Nov 10, 2026
7 checks passed
@hlenke
hlenke deleted the docs/email-channel-recipients branch November 10, 2026 01:00

This branch was successfully deployed

1 active deployment
staging — ec450594 Deployed Nov 10, 2026 by mintlify[bot]
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.

1 participant