From 97ea8cf075014c1ffe19ce9c21b6b9cb6ab1cd49 Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Thu, 2 Apr 2026 14:19:29 +0200 Subject: [PATCH 01/10] docs(constructs): add description property to check/monitor config tables --- constructs/api-check.mdx | 1 + constructs/browser-check.mdx | 1 + constructs/heartbeat-monitor.mdx | 1 + constructs/multistep-check.mdx | 1 + constructs/playwright-check.mdx | 1 + snippets/general-monitor-options-table.mdx | 1 + 6 files changed, 6 insertions(+) diff --git a/constructs/api-check.mdx b/constructs/api-check.mdx index 23748cd6..367949d5 100644 --- a/constructs/api-check.mdx +++ b/constructs/api-check.mdx @@ -90,6 +90,7 @@ The API Check configuration consists of specific API Check options and inherited | Property | Type | Required | Default | Description | |----------|------|----------|---------|-------------| | `name` | `string` | ✅ | - | Friendly name for your check | +| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters | | `activated` | `boolean` | ❌ | `true` | Whether the check is enabled | | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications | | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings | diff --git a/constructs/browser-check.mdx b/constructs/browser-check.mdx index 9d22b1aa..9bbfb9b1 100644 --- a/constructs/browser-check.mdx +++ b/constructs/browser-check.mdx @@ -76,6 +76,7 @@ The Browser Check configuration consists of specific Browser Check options and i | Property | Type | Required | Default | Description | |----------|------|----------|---------|-------------| | `name` | `string` | ✅ | - | Friendly name for your check | +| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters | | `activated` | `boolean` | ❌ | `true` | Whether the check is enabled | | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications | | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings | diff --git a/constructs/heartbeat-monitor.mdx b/constructs/heartbeat-monitor.mdx index d301373f..d2cf9943 100644 --- a/constructs/heartbeat-monitor.mdx +++ b/constructs/heartbeat-monitor.mdx @@ -73,6 +73,7 @@ The Heartbeat Monitoring configuration consists of specific heartbeat monitoring | Property | Type | Required | Default | Description | |----------|------|----------|---------|-------------| | `name` | `string` | ✅ | - | Friendly name for your monitor | +| `description` | `string` | ❌ | `null` | A description of the monitor. Supports markdown. Max 500 characters | | `activated` | `boolean` | ❌ | `true` | Whether the monitor is enabled | | `muted` | `boolean` | ❌ | `false` | Whether alert notifications are muted | | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications | diff --git a/constructs/multistep-check.mdx b/constructs/multistep-check.mdx index de680b60..6aa71487 100644 --- a/constructs/multistep-check.mdx +++ b/constructs/multistep-check.mdx @@ -74,6 +74,7 @@ new MultiStepCheck("complex-multistep-check", { | Property | Type | Required | Default | Description | |----------|------|----------|---------|-------------| | `name` | `string` | ✅ | - | Friendly name for your check | +| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters | | `activated` | `boolean` | ❌ | `true` | Whether the check is enabled | | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications | | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings | diff --git a/constructs/playwright-check.mdx b/constructs/playwright-check.mdx index fb33ebcc..b643a5ad 100644 --- a/constructs/playwright-check.mdx +++ b/constructs/playwright-check.mdx @@ -73,6 +73,7 @@ The Playwright Check Suite configuration consists of specific Playwright Check S | Property | Type | Required | Default | Description | |----------|------|----------|---------|-------------| | `name` | `string` | ✅ | - | Friendly name for your check | +| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters | | `activated` | `boolean` | ❌ | `true` | Whether the check is enabled | | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications | | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings | diff --git a/snippets/general-monitor-options-table.mdx b/snippets/general-monitor-options-table.mdx index 5f2aee52..3abbae5d 100644 --- a/snippets/general-monitor-options-table.mdx +++ b/snippets/general-monitor-options-table.mdx @@ -1,6 +1,7 @@ | Property | Type | Required | Default | Description | |----------|------|----------|---------|-------------| | `name` | `string` | ✅ | - | Friendly name for your monitor | +| `description` | `string` | ❌ | `null` | A description of the monitor. Supports markdown. Max 500 characters | | `activated` | `boolean` | ❌ | `true` | Whether the monitor is enabled | | `alertChannels` | `Array` | ❌ | `[]` | Array of AlertChannel objects for notifications | | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert escalation settings | From 6c900d65bd2eac109832e06adea82a8fed795e9e Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Thu, 2 Apr 2026 14:25:52 +0200 Subject: [PATCH 02/10] docs: add description to project and playwright config pages --- constructs/project.mdx | 1 + detect/synthetic-monitoring/playwright-checks/configuration.mdx | 1 + 2 files changed, 2 insertions(+) diff --git a/constructs/project.mdx b/constructs/project.mdx index 97dab000..59eae773 100644 --- a/constructs/project.mdx +++ b/constructs/project.mdx @@ -611,6 +611,7 @@ export default defineConfig({ |----------|------|----------|---------|-------------| | `name` | `string` | ✅ | - | Friendly name for your check | | `logicalId` | `string` | ✅ | - | Unique identifier for your check suite | +| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters | | `activated` | `boolean` | ❌ | `true` | Whether the check suite is enabled | | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications | | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings | diff --git a/detect/synthetic-monitoring/playwright-checks/configuration.mdx b/detect/synthetic-monitoring/playwright-checks/configuration.mdx index b5e3aaf7..5fa5d637 100644 --- a/detect/synthetic-monitoring/playwright-checks/configuration.mdx +++ b/detect/synthetic-monitoring/playwright-checks/configuration.mdx @@ -90,6 +90,7 @@ Learn more about [best practices to organize and structure your Playwright tests A Playwright Check Suite inherits multiple properties from [the abstract `Check` class](/cli/constructs-reference/#check): - `name` +- `description` - `activated` - `muted` - `locations` From 40754a88b6e7b479beedef32208dcc04b4798005 Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Thu, 2 Apr 2026 14:42:02 +0200 Subject: [PATCH 03/10] docs(config): add description field with Rocky AI context to all check config pages --- .../synthetic-monitoring/api-checks/configuration.mdx | 10 +++++++++- .../playwright-checks/configuration.mdx | 4 ++++ .../uptime-monitoring/dns-monitors/configuration.mdx | 1 + .../heartbeat-monitors/configuration.mdx | 10 +++++++++- .../uptime-monitoring/icmp-monitors/configuration.mdx | 1 + .../uptime-monitoring/tcp-monitors/configuration.mdx | 1 + .../uptime-monitoring/url-monitors/configuration.mdx | 6 ++++++ 7 files changed, 31 insertions(+), 2 deletions(-) diff --git a/detect/synthetic-monitoring/api-checks/configuration.mdx b/detect/synthetic-monitoring/api-checks/configuration.mdx index d26d7664..5e466e4e 100644 --- a/detect/synthetic-monitoring/api-checks/configuration.mdx +++ b/detect/synthetic-monitoring/api-checks/configuration.mdx @@ -212,4 +212,12 @@ This list shows all content types that we scrub from the response data. |`video/x-ms-wmv`| |`video/x-msvideo`| |`video/x-flv`| -|`video/webm`| \ No newline at end of file +|`video/webm`| + +## Additional Settings + +* **Name:** Give your check a clear name to identify it in dashboards and alerts +* **Description:** Add context about what this check does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Tags:** Use tags to organize checks across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) +* **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) +* **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations \ No newline at end of file diff --git a/detect/synthetic-monitoring/playwright-checks/configuration.mdx b/detect/synthetic-monitoring/playwright-checks/configuration.mdx index 5fa5d637..9e922d42 100644 --- a/detect/synthetic-monitoring/playwright-checks/configuration.mdx +++ b/detect/synthetic-monitoring/playwright-checks/configuration.mdx @@ -102,6 +102,10 @@ A Playwright Check Suite inherits multiple properties from [the abstract `Check` Check out [the reference documentation](/constructs/project#param-checks-playwright-checks) for more information on these settings. + +Use the `description` property to add context about what your check does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview). + + **Checks' Retry strategy is not applicable for Playwright checks.** Playwright includes its own retry features that can be set up directly in your `playwright.config.ts/js` file with the [`retries`](https://playwright.dev/docs/test-retries) option. This allows for more detailed management of test retries within Playwright, when your check runs. diff --git a/detect/uptime-monitoring/dns-monitors/configuration.mdx b/detect/uptime-monitoring/dns-monitors/configuration.mdx index 7848e7ce..5102074d 100644 --- a/detect/uptime-monitoring/dns-monitors/configuration.mdx +++ b/detect/uptime-monitoring/dns-monitors/configuration.mdx @@ -323,6 +323,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours): ### Additional Settings * **Name:** Give your monitor a clear name to identify it in dashboards and alerts +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations diff --git a/detect/uptime-monitoring/heartbeat-monitors/configuration.mdx b/detect/uptime-monitoring/heartbeat-monitors/configuration.mdx index 55da02ef..d5e326df 100644 --- a/detect/uptime-monitoring/heartbeat-monitors/configuration.mdx +++ b/detect/uptime-monitoring/heartbeat-monitors/configuration.mdx @@ -2,4 +2,12 @@ title: Heartbeat Configuration description: Ensure your critical automated processes are running as expected. sidebarTitle: Configuration ---- \ No newline at end of file +--- + +### Additional Settings + +* **Name:** Give your monitor a clear name to identify it in dashboards and alerts +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) +* **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) +* **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations \ No newline at end of file diff --git a/detect/uptime-monitoring/icmp-monitors/configuration.mdx b/detect/uptime-monitoring/icmp-monitors/configuration.mdx index 6bc2edd2..7930c18c 100644 --- a/detect/uptime-monitoring/icmp-monitors/configuration.mdx +++ b/detect/uptime-monitoring/icmp-monitors/configuration.mdx @@ -101,6 +101,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours): ### Additional Settings * **Name:** Give your monitor a clear name to identify it in dashboards and alerts +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations diff --git a/detect/uptime-monitoring/tcp-monitors/configuration.mdx b/detect/uptime-monitoring/tcp-monitors/configuration.mdx index 78a83dc4..e2737a82 100644 --- a/detect/uptime-monitoring/tcp-monitors/configuration.mdx +++ b/detect/uptime-monitoring/tcp-monitors/configuration.mdx @@ -65,6 +65,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours): ### Additional Settings * **Name:** Give your monitor a clear name to identify it in dashboards and alerts +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize monitors across dashboards and [maintenance windows](/communicate/maintenance-windows/overview) * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations diff --git a/detect/uptime-monitoring/url-monitors/configuration.mdx b/detect/uptime-monitoring/url-monitors/configuration.mdx index 36ff19c8..b47edd5a 100644 --- a/detect/uptime-monitoring/url-monitors/configuration.mdx +++ b/detect/uptime-monitoring/url-monitors/configuration.mdx @@ -139,6 +139,12 @@ Define where notifications are sent when checks fail or recover. Additional chan **Global Alert Settings**: By default, monitors inherit your account's notification preferences. Select "Use specific notification settings" to customize alerts for individual monitors. +### Additional Settings + +* **Name:** Give your monitor a clear name to identify it in dashboards and alerts +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) + From 8c09676eaac88fe45ef4eb31f92cc9a61291ab99 Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Thu, 2 Apr 2026 14:44:18 +0200 Subject: [PATCH 04/10] docs(rocky-ai): add check description to list of artifacts used in analysis --- platform/rocky-ai.mdx | 2 +- resolve/ai-root-cause-analysis/overview.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/platform/rocky-ai.mdx b/platform/rocky-ai.mdx index aafd0ec7..66d02eab 100644 --- a/platform/rocky-ai.mdx +++ b/platform/rocky-ai.mdx @@ -5,7 +5,7 @@ sidebarTitle: Rocky AI --- Rocky AI is Checkly's AI agent. Rocky AI can help you automatically determine user impact and root cause on any failing -check using error messages, code, metrics, traces and logs. +check using error messages, code, check descriptions, metrics, traces and logs. ## Rocky AI capabilities diff --git a/resolve/ai-root-cause-analysis/overview.mdx b/resolve/ai-root-cause-analysis/overview.mdx index ab9cc14f..fa97b895 100644 --- a/resolve/ai-root-cause-analysis/overview.mdx +++ b/resolve/ai-root-cause-analysis/overview.mdx @@ -22,7 +22,7 @@ synthetic checks and / or monitoring checks. /> -Using any available artifacts like error message, user code, logs, metrics, trace routes, packet captures, Playwright traces, screenshots +Using any available artifacts like error message, user code, check description, logs, metrics, trace routes, packet captures, Playwright traces, screenshots and other evidence, it will quickly assess what the impact is of a failure and what the underlying (possible) root cause is. It will also provide a suggested code fix for any check based on (Playwright) code. From 3bc4b5359af0a338a3f34e059226384af1332753 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susa=20T=C3=BCnker?= Date: Thu, 2 Apr 2026 15:45:30 +0200 Subject: [PATCH 05/10] Add missing description references --- quickstarts/api-check.mdx | 9 ++++++--- quickstarts/heartbeat-monitor.mdx | 2 +- quickstarts/multistep-check.mdx | 10 +++++++--- quickstarts/tcp-monitor.mdx | 1 + quickstarts/url-monitor.mdx | 1 + 5 files changed, 16 insertions(+), 7 deletions(-) diff --git a/quickstarts/api-check.mdx b/quickstarts/api-check.mdx index a63a2f33..5b989769 100644 --- a/quickstarts/api-check.mdx +++ b/quickstarts/api-check.mdx @@ -10,12 +10,15 @@ Learn more about all the [API Check capabilities](/detect/synthetic-monitoring/a ![Screenshot of the create API check page](/images/docs/images/api-checks/overview-create-check.png) -### Name and tags +### Name, tags, and description -A meaningful name will not only help you and others identify your checks within Checkly, but it will help provide a better alerting experience if your checks fall into an alert state. +* **Name:** A meaningful name helps you and your team quickly identify checks and improves the clarity of alerts when something fails -Tags can relate your checks together. They also determine which checks are shown on your [dashboards](/dashboards/). +* **Tags:** let you group related checks and control which ones appear on your [dashboards](/dashboards/) +* **Descriptions:** add context about what a check does or why it exists + +Together, these fields improve alert clarity and play an important role in incident investigation. [Rocky AI](/resolve/ai-root-cause-analysis/overview) uses this information to provide more accurate root cause and user impact analysis. ### HTTP request diff --git a/quickstarts/heartbeat-monitor.mdx b/quickstarts/heartbeat-monitor.mdx index a5612443..8324cd05 100644 --- a/quickstarts/heartbeat-monitor.mdx +++ b/quickstarts/heartbeat-monitor.mdx @@ -34,7 +34,7 @@ Before creating your heartbeat monitor, make sure you have: ## Step 1: Basic Configuration -Start by giving your monitor a descriptive name and relevant tags. Choose something descriptive that clearly identifies what the monitor is tracking, like "Nightly Database Backup" or "Weekly Reports Job". +Start by giving your monitor a descriptive name and optionally adding tags and a description. Use tags to group related monitors and make them easier to find and manage. diff --git a/quickstarts/multistep-check.mdx b/quickstarts/multistep-check.mdx index a6efa9b1..de0277e1 100644 --- a/quickstarts/multistep-check.mdx +++ b/quickstarts/multistep-check.mdx @@ -18,11 +18,15 @@ You'll need a series of API endpoints that work together to complete a business ![Multistep check edit page](/images/docs/images/multistep-api-checks/create-multistep-check.png) -### Name and tags +### Name, tags, and description -A meaningful name will not only help you and others identify your checks within Checkly, but it will help provide a better alerting experience if your checks fall into an alert state. +* **Name:** A meaningful name helps you and your team quickly identify checks and improves the clarity of alerts when something fails -Tags can relate your checks together. They also determine which checks are shown on your [dashboards](/dashboards/). +* **Tags:** let you group related checks and control which ones appear on your [dashboards](/dashboards/) + +* **Descriptions:** add context about what a check does or why it exists + +Together, these fields improve alert clarity and play an important role in incident investigation. [Rocky AI](/resolve/ai-root-cause-analysis/overview) uses this information to provide more accurate root cause and user impact analysis. ### Playwright script diff --git a/quickstarts/tcp-monitor.mdx b/quickstarts/tcp-monitor.mdx index 014a749f..79715181 100644 --- a/quickstarts/tcp-monitor.mdx +++ b/quickstarts/tcp-monitor.mdx @@ -68,6 +68,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours): * **Name:** Give your monitor a clear name to identify it in dashboards and alerts * **Tags:** Use tags to organize monitors across dashboards and [maintenance windows](/communicate/maintenance-windows/overview) +* **Description:** A description of the check. Supports Markdown. Maximum length: 500 characters * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations diff --git a/quickstarts/url-monitor.mdx b/quickstarts/url-monitor.mdx index e74942f9..75126489 100644 --- a/quickstarts/url-monitor.mdx +++ b/quickstarts/url-monitor.mdx @@ -62,6 +62,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours). * **Name:** Give your monitor a clear name to identify it in dashboards and alerts * **Tags:** Use tags to organize monitors across dashboards and [maintenance windows](/communicate/maintenance-windows/overview) +* **Description:** A short description of the check. Supports Markdown. Maximum length: 500 characters * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations From e0fed9aab68b8c924a6e217463c8c719029fc141 Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Fri, 3 Apr 2026 12:25:29 +0200 Subject: [PATCH 06/10] revert(constructs): remove description from project config table --- constructs/project.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/constructs/project.mdx b/constructs/project.mdx index 59eae773..97dab000 100644 --- a/constructs/project.mdx +++ b/constructs/project.mdx @@ -611,7 +611,6 @@ export default defineConfig({ |----------|------|----------|---------|-------------| | `name` | `string` | ✅ | - | Friendly name for your check | | `logicalId` | `string` | ✅ | - | Unique identifier for your check suite | -| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters | | `activated` | `boolean` | ❌ | `true` | Whether the check suite is enabled | | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications | | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings | From cc0f6a0cb73339ba894b0e9fbdbe39ec922cc9e7 Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Fri, 3 Apr 2026 12:26:33 +0200 Subject: [PATCH 07/10] docs(playwright): remove description Tip, keep as bullet point only --- .../synthetic-monitoring/playwright-checks/configuration.mdx | 4 ---- 1 file changed, 4 deletions(-) diff --git a/detect/synthetic-monitoring/playwright-checks/configuration.mdx b/detect/synthetic-monitoring/playwright-checks/configuration.mdx index 9e922d42..5fa5d637 100644 --- a/detect/synthetic-monitoring/playwright-checks/configuration.mdx +++ b/detect/synthetic-monitoring/playwright-checks/configuration.mdx @@ -102,10 +102,6 @@ A Playwright Check Suite inherits multiple properties from [the abstract `Check` Check out [the reference documentation](/constructs/project#param-checks-playwright-checks) for more information on these settings. - -Use the `description` property to add context about what your check does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview). - - **Checks' Retry strategy is not applicable for Playwright checks.** Playwright includes its own retry features that can be set up directly in your `playwright.config.ts/js` file with the [`retries`](https://playwright.dev/docs/test-retries) option. This allows for more detailed management of test retries within Playwright, when your check runs. From 62bf1bd124fcf67dace47c2c8eb92625e4d8179d Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Fri, 3 Apr 2026 12:27:22 +0200 Subject: [PATCH 08/10] docs(alerts): add CHECK_DESCRIPTION variable to webhook reference table --- integrations/alerts/webhooks.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/integrations/alerts/webhooks.mdx b/integrations/alerts/webhooks.mdx index dbf27b23..7d0fbe34 100644 --- a/integrations/alerts/webhooks.mdx +++ b/integrations/alerts/webhooks.mdx @@ -44,6 +44,7 @@ You can use the following event-related variables in both URL and payload. | `API_CHECK_RESPONSE_STATUS_TEXT` | The response status text, e.g. "OK". Only populated for API checks. | | `CHECK_ERROR_MESSAGE` | The check error message | | `CHECK_ID` | The UUID of the check | +| `CHECK_DESCRIPTION` | The description of the check, if set | | `CHECK_NAME` | Full name of the check | | `CHECK_RESULT_ID` | The UUID of the result that triggered this message | | `CHECK_TYPE` | The check type, e.g. API, BROWSER . | From 0e04457618279386a48194b847fa2acaf8957dfd Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Fri, 3 Apr 2026 12:32:00 +0200 Subject: [PATCH 09/10] fix(docs): update rocky-ai links from /platform/ to /ai/ after move --- detect/synthetic-monitoring/api-checks/configuration.mdx | 2 +- detect/uptime-monitoring/dns-monitors/configuration.mdx | 2 +- detect/uptime-monitoring/heartbeat-monitors/configuration.mdx | 2 +- detect/uptime-monitoring/icmp-monitors/configuration.mdx | 2 +- detect/uptime-monitoring/tcp-monitors/configuration.mdx | 2 +- detect/uptime-monitoring/url-monitors/configuration.mdx | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/detect/synthetic-monitoring/api-checks/configuration.mdx b/detect/synthetic-monitoring/api-checks/configuration.mdx index 5e466e4e..73cab963 100644 --- a/detect/synthetic-monitoring/api-checks/configuration.mdx +++ b/detect/synthetic-monitoring/api-checks/configuration.mdx @@ -217,7 +217,7 @@ This list shows all content types that we scrub from the response data. ## Additional Settings * **Name:** Give your check a clear name to identify it in dashboards and alerts -* **Description:** Add context about what this check does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Description:** Add context about what this check does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/ai/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize checks across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations \ No newline at end of file diff --git a/detect/uptime-monitoring/dns-monitors/configuration.mdx b/detect/uptime-monitoring/dns-monitors/configuration.mdx index 5102074d..f6a0d442 100644 --- a/detect/uptime-monitoring/dns-monitors/configuration.mdx +++ b/detect/uptime-monitoring/dns-monitors/configuration.mdx @@ -323,7 +323,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours): ### Additional Settings * **Name:** Give your monitor a clear name to identify it in dashboards and alerts -* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/ai/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations diff --git a/detect/uptime-monitoring/heartbeat-monitors/configuration.mdx b/detect/uptime-monitoring/heartbeat-monitors/configuration.mdx index d5e326df..3761ad88 100644 --- a/detect/uptime-monitoring/heartbeat-monitors/configuration.mdx +++ b/detect/uptime-monitoring/heartbeat-monitors/configuration.mdx @@ -7,7 +7,7 @@ sidebarTitle: Configuration ### Additional Settings * **Name:** Give your monitor a clear name to identify it in dashboards and alerts -* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/ai/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations \ No newline at end of file diff --git a/detect/uptime-monitoring/icmp-monitors/configuration.mdx b/detect/uptime-monitoring/icmp-monitors/configuration.mdx index 7930c18c..eb2713f8 100644 --- a/detect/uptime-monitoring/icmp-monitors/configuration.mdx +++ b/detect/uptime-monitoring/icmp-monitors/configuration.mdx @@ -101,7 +101,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours): ### Additional Settings * **Name:** Give your monitor a clear name to identify it in dashboards and alerts -* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/ai/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations diff --git a/detect/uptime-monitoring/tcp-monitors/configuration.mdx b/detect/uptime-monitoring/tcp-monitors/configuration.mdx index e2737a82..88343fb4 100644 --- a/detect/uptime-monitoring/tcp-monitors/configuration.mdx +++ b/detect/uptime-monitoring/tcp-monitors/configuration.mdx @@ -65,7 +65,7 @@ Set how often the monitor runs (every 10 seconds to 24 hours): ### Additional Settings * **Name:** Give your monitor a clear name to identify it in dashboards and alerts -* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/ai/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize monitors across dashboards and [maintenance windows](/communicate/maintenance-windows/overview) * **Retries:** Define how failed runs should be retried. See [retry strategies](/communicate/alerts/retries) * **Alerting:** Configure your [alert settings](/communicate/alerts/configuration), [alert channels](/communicate/alerts/channels), or set up [webhooks](/integrations/alerts/webhooks) for custom integrations diff --git a/detect/uptime-monitoring/url-monitors/configuration.mdx b/detect/uptime-monitoring/url-monitors/configuration.mdx index b47edd5a..70187bfa 100644 --- a/detect/uptime-monitoring/url-monitors/configuration.mdx +++ b/detect/uptime-monitoring/url-monitors/configuration.mdx @@ -142,7 +142,7 @@ Define where notifications are sent when checks fail or recover. Additional chan ### Additional Settings * **Name:** Give your monitor a clear name to identify it in dashboards and alerts -* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/platform/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) +* **Description:** Add context about what this monitor does and why it matters. Supports markdown, max 500 characters. When a failure occurs, [Rocky AI](/ai/rocky-ai) uses the description to provide more accurate [root cause and user impact analysis](/resolve/ai-root-cause-analysis/overview) * **Tags:** Use tags to organize monitors across [dashboards](/communicate/dashboards/overview/) and [maintenance windows](/communicate/maintenance-windows/overview) From 7552684bbe2cef3ec5f0e14066bd54846beeed1a Mon Sep 17 00:00:00 2001 From: Paula Mallol Date: Fri, 3 Apr 2026 12:36:28 +0200 Subject: [PATCH 10/10] docs: restore text and only add descriptions description --- quickstarts/heartbeat-monitor.mdx | 2 +- quickstarts/multistep-check.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/quickstarts/heartbeat-monitor.mdx b/quickstarts/heartbeat-monitor.mdx index 8324cd05..53e0c41c 100644 --- a/quickstarts/heartbeat-monitor.mdx +++ b/quickstarts/heartbeat-monitor.mdx @@ -34,7 +34,7 @@ Before creating your heartbeat monitor, make sure you have: ## Step 1: Basic Configuration -Start by giving your monitor a descriptive name and optionally adding tags and a description. +Start by giving your monitor a descriptive name and relevant tags and description. Choose something descriptive that clearly identifies what the monitor is tracking, like "Nightly Database Backup" or "Weekly Reports Job". Use tags to group related monitors and make them easier to find and manage. diff --git a/quickstarts/multistep-check.mdx b/quickstarts/multistep-check.mdx index de0277e1..de419031 100644 --- a/quickstarts/multistep-check.mdx +++ b/quickstarts/multistep-check.mdx @@ -20,9 +20,9 @@ You'll need a series of API endpoints that work together to complete a business ### Name, tags, and description -* **Name:** A meaningful name helps you and your team quickly identify checks and improves the clarity of alerts when something fails +* **Name:** a meaningful name will not only help you and others identify your checks within Checkly, but it will help provide a better alerting experience if your checks fall into an alert state -* **Tags:** let you group related checks and control which ones appear on your [dashboards](/dashboards/) +* **Tags:** let you relate your checks together. They also determine which checks are shown on your [dashboards](/dashboards/) * **Descriptions:** add context about what a check does or why it exists