From e4f2bf864d2919dc710f87701e715610c19347e0 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 23 Oct 2026 13:08:49 +0000 Subject: [PATCH] docs: clarify adding email alert channels and escaping special characters in variables --- .../api-checks/configuration.mdx | 2 ++ .../url-monitors/configuration.mdx | 2 ++ integrations/alerts/email.mdx | 14 +++++++++++++- platform/variables.mdx | 2 ++ 4 files changed, 19 insertions(+), 1 deletion(-) diff --git a/detect/synthetic-monitoring/api-checks/configuration.mdx b/detect/synthetic-monitoring/api-checks/configuration.mdx index 6977306c..1e2c5a6c 100644 --- a/detect/synthetic-monitoring/api-checks/configuration.mdx +++ b/detect/synthetic-monitoring/api-checks/configuration.mdx @@ -93,6 +93,8 @@ request by entering a username and password in the Authentication tab. [Environment variables](/platform/variables) are exposed to your API checks using the common Handlebars/Moustache templating delimiters, i.e. `{{USER_API_KEY}}`. Note that Handlebars (double brackets) variables will be URI encoded. To avoid encoding, you can access your environment variables with triple brackets, i.e. `{{{USER_API_KEY}}}`. +Use triple brackets for values that contain special characters, such as API keys or tokens with `&`. With double brackets, `&` is inserted as `&`, which can make the check fail. + Variables can be used in the following API checks fields: - URL diff --git a/detect/uptime-monitoring/url-monitors/configuration.mdx b/detect/uptime-monitoring/url-monitors/configuration.mdx index f5909aad..312c0ca3 100644 --- a/detect/uptime-monitoring/url-monitors/configuration.mdx +++ b/detect/uptime-monitoring/url-monitors/configuration.mdx @@ -131,6 +131,8 @@ Configure follow-up alerts after initial failure notification: Define where notifications are sent when checks fail or recover. Additional channels can be configured in global notification settings. +This section only lists alert channels that already exist in your account. You can't type an email address here directly. To alert an email address, first [create an email alert channel](/integrations/alerts/email#basic-email-configuration), then select it for this monitor. + **Alert Types** (per channel): - ✅ **Success/Recovery**: Check has recovered from failure - ⚠ **Degraded**: Check is degraded but not failed diff --git a/integrations/alerts/email.mdx b/integrations/alerts/email.mdx index 1d7f8d3c..b0874780 100644 --- a/integrations/alerts/email.mdx +++ b/integrations/alerts/email.mdx @@ -26,7 +26,19 @@ Email notifications provide a reliable and widely-supported way to receive alert ## Basic Email Configuration -To recieve alerts, you'll need to add a valid email address, choose what states you want to receive alerts for, and then also add subscriptions to checks. +To receive alerts, you'll need to add a valid email address, choose what states you want to receive alerts for, and then also add subscriptions to checks. + +1. Log in to Checkly and navigate to [Alert Settings](https://app.checklyhq.com/alerts/settings). +2. Click **Add more channels**, find **Email** on the list, and click **Add channel**. +3. Enter the email address. You can use an individual address or a distribution list. +4. Select the alert types you want to receive: failure, degraded, and recovery. +5. Subscribe the checks, monitors, or check groups that should notify this address, then save the channel. + +After you create the channel, it appears in the **Alert Channels** section of each check's and monitor's alert settings. You can turn it on or off per check there. + + +Creating alert channels requires the **Manage alert settings** permission. The Owner, Admin, and Read & Write roles have it. Read & Run and Read Only users can't add email addresses. See [Team member roles](/admin/team-management/overview#team-member-roles). + When an alert is triggered, you'll receive an email like below: diff --git a/platform/variables.mdx b/platform/variables.mdx index dc734880..9a05645f 100644 --- a/platform/variables.mdx +++ b/platform/variables.mdx @@ -92,6 +92,8 @@ How variables are accessed depends on where you're accessing them from: Handlebar (double brackets) variables will be URI encoded. To avoid encoding, you can access your environment variables with triple brackets, i.e. `{{{VARIABLE_NAME}}}`. + + Use triple brackets for values that contain special characters, such as API keys or tokens with `&`. With double brackets, `&` is inserted as `&`, which can make the check fail. ## Playwright Check Suite Variables