From 987989f3d86efa45d5588cff5e7abd1779cf5645 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Labas?= <431257+thebiglabasky@users.noreply.github.com> Date: Thu, 27 Nov 2025 19:06:54 +0100 Subject: [PATCH 1/8] Improvements to status pages docs --- communicate/status-pages/overview.mdx | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/communicate/status-pages/overview.mdx b/communicate/status-pages/overview.mdx index e187bb05..606fe7a9 100644 --- a/communicate/status-pages/overview.mdx +++ b/communicate/status-pages/overview.mdx @@ -10,7 +10,7 @@ Status pages provide transparent communication about your service health and inc ![Status page example](/images/docs/images/status-pages/status-pages-overview-1.png) -## Core Status Page Components +## Core status page components ### Services @@ -38,24 +38,14 @@ You can display the same service on multiple pages. An incident declared on that ### Connecting services and checks -Use incident automation to connect a service and a check to automatically open incidents for services based on check alerts. [See Incident automation for details](/communicate/status-pages/incidents#incident-automation). +Use [incident automation](/communicate/status-pages/incidents#incident-automation) to connect a service and a check to automatically open incidents for services based on check alerts. [See Incident automation for details](/communicate/status-pages/incidents#incident-automation). -## Status Page Best Practices +## Best practices for status pages -### Service Organization -- **User-centric services**: Create services based on user-facing functionality -- **Logical grouping**: Group related services together for clarity -- **Clear descriptions**: Use terminology your users understand -- **Appropriate granularity**: Balance detail with simplicity +### Service organization -### Incident Communication -- **Timely updates**: Provide regular updates during ongoing incidents -- **Clear messaging**: Use plain language to describe issues and impacts -- **Proactive communication**: Notify users before they notice problems -- **Transparent resolution**: Explain what was fixed and preventive measures +Services on your status page should reflect how your users think about your product. Name them using terminology your users understand—for example, "API", "Dashboard", or "Payment Processing" rather than internal system names. Group related functionality under a single service when it makes sense to users, but keep services separate when they represent distinct features that might fail independently. -### Maintenance Planning -- **Advance notice**: Schedule maintenance announcements with sufficient lead time -- **Impact assessment**: Clearly communicate which services will be affected -- **Duration estimates**: Provide realistic timeframes for maintenance windows -- **Progress updates**: Keep users informed during maintenance activities +### Incident communication + +When an incident occurs, provide clear updates that explain what's happening and how it affects users. Write in plain language, avoiding technical jargon unless your audience is technical. Update the incident as you learn more about the issue, and close it with an explanation of what was fixed. Where possible, communicate proactively to maximize chances to warn users before they encounter problems themselves. From f344ecc8edb8903108b461a21e89e73ca31ef2a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Labas?= Date: Thu, 27 Nov 2025 19:17:43 +0100 Subject: [PATCH 2/8] First batch of improvements to status page removing auto-generated gibberish --- .../status-pages/creating-a-status-page.mdx | 2 +- communicate/status-pages/incidents.mdx | 5 +++- .../status-pages/subscriber-notifications.mdx | 24 +++++++------------ 3 files changed, 14 insertions(+), 17 deletions(-) diff --git a/communicate/status-pages/creating-a-status-page.mdx b/communicate/status-pages/creating-a-status-page.mdx index 64fbaf22..74f4bb93 100644 --- a/communicate/status-pages/creating-a-status-page.mdx +++ b/communicate/status-pages/creating-a-status-page.mdx @@ -37,5 +37,5 @@ Third-party Integrations: ``` -Create services from your users' perspective, not your internal architecture. Users care about "Login" working, not whether your "Auth microservice cluster" is healthy. +Create services to match how your users perceive your system, not according to your internal architecture. Users care about "Login" working, not whether your "Auth microservice cluster" is healthy. \ No newline at end of file diff --git a/communicate/status-pages/incidents.mdx b/communicate/status-pages/incidents.mdx index cfc4c78d..4c3c100a 100644 --- a/communicate/status-pages/incidents.mdx +++ b/communicate/status-pages/incidents.mdx @@ -67,6 +67,10 @@ Incident automation opens incidents automatically whenever a check fails. It wor * When the check fails and triggers an alert, it will also open an incident on the connected service. * The incident will be automatically resolved when the check recovers. + +Incident automation is available on the "Communicate Team" pricing add-on. + + 1. Open your check from the home dashboard. 2. Click ‘Edit’ in the check overview page. 3. For API checks, URL monitors and TCP monitors, click the ‘Incident triggers’ tab. For Browser and Multistep checks, first click ‘Settings’ then ‘Incident automation’. @@ -86,7 +90,6 @@ To backfill an incident, follow the steps 1 - 7 in the [Creating an incident](/c ![Incident backfilling](/images/docs/images/status-pages/status-pages-backfilling-1.png) - We recommend to uncheck notifications when backfilling incidents to avoid notifying customers about resolved incidents. If you only want to provide the history of the incident, you can set the first incident update to resolved. This will correctly show the incident as having occurred, but without a duration. If you want to have correct uptime on your service you should post two incident updates, with the timestamps for when the incident started and resolved respectively. diff --git a/communicate/status-pages/subscriber-notifications.mdx b/communicate/status-pages/subscriber-notifications.mdx index 5501c2cf..dd23395b 100644 --- a/communicate/status-pages/subscriber-notifications.mdx +++ b/communicate/status-pages/subscriber-notifications.mdx @@ -4,31 +4,25 @@ description: 'Configure subscriber notifications.' sidebarTitle: 'Subscriber Notifications' --- - - -### Email Subscription System -Enable users to stay informed about service status: +### Subscribing to status page updates Syste +Your users can choose to be notified about any incident impacting your services by doing the following: - -Users provide email address for status updates - - - -Verification email sent to confirm subscription + +By clicking the "Get updates" button at the top of the status page, users are directed to a form to fill in their email address. - -Users can manage notification settings + +A verification email is sent to confirm their subscription. -Automatic emails for incident updates and resolutions +From that moment on, subscribers will receive emails for incident updates and resolutions. They can choose to unsubscribe to these email at any time. -### Notification Content Structure -Status page notifications include comprehensive incident information: +### Notification content structure +Here is an example of a status page notifications email: ```text Subject: [INCIDENT] Payment Processing - Service Disruption From 8388ba85335e0cbfe73085ab002a911a6ebe4194 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Labas?= Date: Fri, 28 Nov 2025 12:33:13 +0100 Subject: [PATCH 3/8] List subscribers page, add callout to how we handle limits, some formatting and tweaking --- .../status-pages/creating-a-status-page.mdx | 42 ++++--------------- communicate/status-pages/customization.mdx | 32 +++++++++++--- communicate/status-pages/incidents.mdx | 18 ++++---- communicate/status-pages/overview.mdx | 34 +++++++++++++-- .../status-pages/subscriber-notifications.mdx | 22 ++++++---- docs.json | 3 +- 6 files changed, 90 insertions(+), 61 deletions(-) diff --git a/communicate/status-pages/creating-a-status-page.mdx b/communicate/status-pages/creating-a-status-page.mdx index 74f4bb93..829f9414 100644 --- a/communicate/status-pages/creating-a-status-page.mdx +++ b/communicate/status-pages/creating-a-status-page.mdx @@ -1,41 +1,15 @@ --- title: 'Creating a Status Page' -description: 'Create a status page.' +description: 'Create a Status Page.' sidebarTitle: 'Creating a Status Page' --- -To set up a status page, select ‘New status page’ on the [Status page overview](https://app.checklyhq.com/status-pages). +To set up a Status Page, select ‘New status page’ on the [Status page overview](https://app.checklyhq.com/status-pages). -1. Begin by selecting a name for your page. -2. Next, create at least one **card** for your page. Cards define the order and grouping of services on your page. One card can contain one or multiple **services** and will show the average uptime for all the services on the card. -3. If you haven’t already created a service for your page, you can do so from the `Services` dropdown. [Read more about services here](/communicate/status-pages/overview#services). -4. Select a subdomain for your page. By default status pages will use the domain `.checkly-status-pages.com` but you can also use your own domain. See [Custom domains](/communicate/status-pages/customization#custom-domains) for details on how to configure this. -5. When you are happy with your setup, click ‘Create status page.’ You will now see a preview of your page, and below the status page name, you have a link to the public page. +1. Begin by entering a name for your page. +2. Next, fill in the first **card**'s title and add services to it. Cards enable grouping **services** on your page and will show the average uptime for all the services listed on the card. +3. If you haven’t already created any service yet, you can do so from the `Services` dropdown by typing a name and clicking `Create`. See [Services](/communicate/status-pages/overview#services) for more details. +4. Customize the subdomain for your page. By default status pages will use the domain `.checkly-status-pages.com` but you can also use your own domain. See [Custom domains](/communicate/status-pages/customization#custom-domains) for more details. +5. When you are happy with your setup, click ‘Create status page.’ You will now see a preview of your page, and a link to the public version of the page below the title. -You can now share the link to your status page, and your users can subscribe to receive notifications when incidents are posted. - -### Service Creation and Management - -Create services that align with how your users think about your application: - -```yaml -# Good service examples -Frontend Application: - - Website loading and navigation - - User interface responsiveness - - Client-side functionality - -API Services: - - Core API endpoints - - Authentication services - - Data processing capabilities - -Third-party Integrations: - - Payment processors - - Email delivery services - - External data sources -``` - - -Create services to match how your users perceive your system, not according to your internal architecture. Users care about "Login" working, not whether your "Auth microservice cluster" is healthy. - \ No newline at end of file +You can now share the link to your Status Page, and your users can subscribe to receive notifications when incidents are posted! diff --git a/communicate/status-pages/customization.mdx b/communicate/status-pages/customization.mdx index 73229303..ac00254c 100644 --- a/communicate/status-pages/customization.mdx +++ b/communicate/status-pages/customization.mdx @@ -4,25 +4,45 @@ description: 'Add a custom domain and look & feel to your Status Page.' sidebarTitle: 'Customization' --- -## Custom Domain +## Custom domain + + +Custom domains are available on Communicate Starter and higher plans. [View pricing](https://checklyhq.com/pricing) + + You can host your Status Page under your own domain. To make this work, you need to do a few things: -1. Add a valid custom domain to your status page. + + ![Custom domain configuration](/images/docs/images/status-pages/status-pages-custom-domain-1.png) + -2. Create a CNAME record in your DNS that points to custom-domain.checkly-status-page.com + Any DNS provider will have the option to easily add CNAME records. For example on Cloudflare this looks as follows. ![Custom domain CNAME configuration](/images/docs/images/status-pages/status-pages-custom-domain-2.png) If your provider is Cloudflare, you also need to disable the proxy on the CNAME, it should always be set to DNS only. + -3. Verify you are the owner of the domain by adding a `TXT` record to your DNS. The record can be copied from the status page configuration page after providing a custom domain and saving the page once. + +The record can be copied from the Status Page configuration page after providing a custom domain and saving the page once. -4. Add validation `TXT` record(s). The record can be copied from the status page configuration page after providing a custom domain and saving the page once. + +Your custom domain needs this verification in order for search engines to list your Status Page. + + + +The record can be copied from the Status Page configuration page after providing a custom domain and saving the page once. ![Custom domain CNAME configuration](/images/docs/images/status-pages/status-pages-custom-domain-3.png) + + -## Customize your status page to match your brand identity +## Customize your Status Page to match your brand identity - Upload your company logo and the link it should direct to - Upload a custom favicon - Choose the default theme between auto (system), light or dark theme - Customize the color theme to match your brand + + +Theme customization is available on Communicate Team and Enterprise plans. [View pricing](https://checklyhq.com/pricing) + diff --git a/communicate/status-pages/incidents.mdx b/communicate/status-pages/incidents.mdx index 4c3c100a..3855b006 100644 --- a/communicate/status-pages/incidents.mdx +++ b/communicate/status-pages/incidents.mdx @@ -6,13 +6,13 @@ sidebarTitle: 'Incidents' Incidents are used to communicate downtime on one or more services. You can open incidents manually as part of your incident management process, or automatically by connecting a check to a service using incident automation. -When an incident is posted, a notification will be sent to all users subscribed to the status page, unless you opt out of notifications when creating the incident update. +When an incident is posted, a notification will be sent to all users subscribed to the Status Page, unless you opt out of notifications when creating the incident update. ## Creating an incident -Create an incident when you want to communicate downtime or known issues of your services to users via your status page. +Create an incident when you want to communicate downtime or known issues of your services to users via your Status Page. -1. Click ‘Status page’ in the sidebar and open your status page. +1. Click ‘Status pages’ in the sidebar and open your Status Page. 2. Click ‘Add incident’ at the top right, or click the fire icon at the bottom of the card that most relates to the incident you're about to create 3. Enter the name of the incident 4. Choose the severity of the incident @@ -22,7 +22,7 @@ Create an incident when you want to communicate downtime or known issues of your 6. Write the initial incident update message, and update the status of the incident. 8. If you want to backfill the incident, select `Use custom date`. See [Backfilling incidents for more information](/communicate/status-pages/incidents#backfilling-an-incident). -9. Select if you want to notify subscribers of your status page about the incident. +9. Select if you want to notify subscribers of your Status Page about the incident. 10. Click ‘Create incident’ Your incident will now appear on all status pages that show the selected service(s). If you selected the option to notify subscribers, they will receive the update message by email. @@ -32,7 +32,7 @@ Your incident will now appear on all status pages that show the selected service ## Updating an incident -To update an ongoing incident go to the ‘Incidents’ tab on your status page and select the incident to update. +To update an ongoing incident go to the ‘Incidents’ tab on your Status Page and select the incident to update. ![Incidents view](/images/docs/images/status-pages/status-pages-incidents-1.png) @@ -45,7 +45,7 @@ From there, you can: ## Incident notifications -Whenever you post an incident update, Checkly can automatically send email notifications to users subscribed to your status page. +Whenever you post an incident update, Checkly can automatically send email notifications to users subscribed to your Status Page. Emails are sent out only when an update is first posted. Notifications are not sent again if the incident update is edited. @@ -59,7 +59,7 @@ Incident notifications contain information about the incident name, the severity ## Subscribing to incident notifications -Subscribing to incident notifications is done on your status page. To subscribe, a user needs to enter a valid email address. A verification email will be sent to the registered email, and the user will be ready to receive incident notifications after confirming the subscription. +Subscribing to incident notifications is done on your Status Page. To subscribe, a user needs to enter a valid email address. A verification email will be sent to the registered email, and the user will be ready to receive incident notifications after confirming the subscription. ## Incident automation @@ -68,7 +68,7 @@ Incident automation opens incidents automatically whenever a check fails. It wor * The incident will be automatically resolved when the check recovers. -Incident automation is available on the "Communicate Team" pricing add-on. +Incident automation is available on Communicate Team and Enterprise plans. [View pricing](https://checklyhq.com/pricing) 1. Open your check from the home dashboard. @@ -77,7 +77,7 @@ Incident automation is available on the "Communicate Team" pricing add-on. 4. Check the ‘Enable incident automation’ checkbox. 5. Fill in the incident name, a first status update and the severity of the incident which will be created upon the check failing. 6. Select which service the incident should be opened on. -7. Select if the status page subscribers should be notified when the incident updates are automatically posted. +7. Select if the Status Page subscribers should be notified when the incident updates are automatically posted. 8. Save your check. ![Incident automation](/images/docs/images/status-pages/status-pages-incident-automation-1.png) diff --git a/communicate/status-pages/overview.mdx b/communicate/status-pages/overview.mdx index 606fe7a9..0cfe4fe4 100644 --- a/communicate/status-pages/overview.mdx +++ b/communicate/status-pages/overview.mdx @@ -10,12 +10,16 @@ Status pages provide transparent communication about your service health and inc ![Status page example](/images/docs/images/status-pages/status-pages-overview-1.png) -## Core status page components +## Core Status Page components ### Services A service represents a functional piece of your application or website, such as landing page, API, support portal etc. You manage your services from the service overview page, accessible in the sidebar. + +The number of services and subscribers you can have varies by plan. [View pricing](https://checklyhq.com/pricing) + + When naming a service, use a name that is identifiable for your users, as this is used when sending out incident notifications. Services are what connect checks and status pages. A service can listen to multiple checks and automatically opening incidents whenever one of these checks trigger a check failure alert. [See incident automation for more details](/communicate/status-pages/incidents#incident-automation). @@ -28,9 +32,9 @@ A service can be used by multiple status pages. When an incident is opened for a ### Connecting services and status pages -To display a service on a status page, go to the status page editor and open the `Services` dropdown on the card you want to display your service on. +To display a service on a Status Page, go to the Status Page editor and open the `Services` dropdown on the card you want to display your service on. -Select your service from the list and save your status page. The page will now display the selected service. +Select your service from the list and save your Status Page. The page will now display the selected service. You can also create new services directly from the dropdown by entering a new service name and pressing `Create`. @@ -44,7 +48,29 @@ Use [incident automation](/communicate/status-pages/incidents#incident-automatio ### Service organization -Services on your status page should reflect how your users think about your product. Name them using terminology your users understand—for example, "API", "Dashboard", or "Payment Processing" rather than internal system names. Group related functionality under a single service when it makes sense to users, but keep services separate when they represent distinct features that might fail independently. +Create services that align with how your users think about your application: + +```yaml +# Good service examples +Frontend Application: + - Website loading and navigation + - User interface responsiveness + - Client-side functionality + +API Services: + - Core API endpoints + - Authentication services + - Data processing capabilities + +Third-party Integrations: + - Payment processors + - Email delivery services + - External data sources +``` + + +Create services to match how your users perceive your system, not according to your internal architecture. Users care about "Login" working, not whether your "Auth microservice cluster" is healthy. + ### Incident communication diff --git a/communicate/status-pages/subscriber-notifications.mdx b/communicate/status-pages/subscriber-notifications.mdx index dd23395b..7e62d870 100644 --- a/communicate/status-pages/subscriber-notifications.mdx +++ b/communicate/status-pages/subscriber-notifications.mdx @@ -4,25 +4,25 @@ description: 'Configure subscriber notifications.' sidebarTitle: 'Subscriber Notifications' --- -### Subscribing to status page updates Syste +## Subscribing to incident updates Your users can choose to be notified about any incident impacting your services by doing the following: - -By clicking the "Get updates" button at the top of the status page, users are directed to a form to fill in their email address. + +By clicking the "Get updates" button at the top of the Status Page, users are directed to a form to fill in their email address. - + A verification email is sent to confirm their subscription. - + From that moment on, subscribers will receive emails for incident updates and resolutions. They can choose to unsubscribe to these email at any time. ### Notification content structure -Here is an example of a status page notifications email: +Here is an example of a Status Page notifications email: ```text Subject: [INCIDENT] Payment Processing - Service Disruption @@ -40,9 +40,17 @@ Incident Details: We are actively working to resolve this issue and will provide updates as more information becomes available. -View status page: https://status.yourcompany.com +View Status Page: https://status.yourcompany.com Unsubscribe: [unsubscribe link] Best regards, Your Company Team ``` + +## How Checkly deals with subscribers limits based on your plan + +If you've purchased a Communicate Starter or Communicate Team add-on, **extra subscribers will automatically be charged as overages**. +You will receive an email notification about it, and can monitor your overages from [your Checkly account billing page](https://app.checklyhq.com/settings/account/billing). + +If you have not purchased any Communicate add-on, we will continue accepting new subscribers to your page, yet will only send notifications to the first 250 subscribers. [View pricing for more details about limits](https://wwW.checklyhq.com/pricing). + diff --git a/docs.json b/docs.json index 4bcb0e3e..eaab8049 100644 --- a/docs.json +++ b/docs.json @@ -277,7 +277,8 @@ "communicate/status-pages/overview", "communicate/status-pages/creating-a-status-page", "communicate/status-pages/customization", - "communicate/status-pages/incidents" + "communicate/status-pages/incidents", + "communicate/status-pages/subscriber-notifications" ] }, { From 1466f57f1fddffd3ac6564eb3edde4fb0aaf1bc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Labas?= Date: Fri, 28 Nov 2025 12:43:50 +0100 Subject: [PATCH 4/8] Fixes after some AI-review --- communicate/status-pages/customization.mdx | 10 +++++----- communicate/status-pages/overview.mdx | 2 +- communicate/status-pages/subscriber-notifications.mdx | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/communicate/status-pages/customization.mdx b/communicate/status-pages/customization.mdx index ac00254c..86e27065 100644 --- a/communicate/status-pages/customization.mdx +++ b/communicate/status-pages/customization.mdx @@ -23,16 +23,16 @@ Any DNS provider will have the option to easily add CNAME records. For example o If your provider is Cloudflare, you also need to disable the proxy on the CNAME, it should always be set to DNS only. - -The record can be copied from the Status Page configuration page after providing a custom domain and saving the page once. + +The owner verification TXT record details can be copied from the Status Page configuration section page after providing a custom domain and saving the page once. Your custom domain needs this verification in order for search engines to list your Status Page. -The record can be copied from the Status Page configuration page after providing a custom domain and saving the page once. -![Custom domain CNAME configuration](/images/docs/images/status-pages/status-pages-custom-domain-3.png) +The validation TXT record details can be copied from the Status Page configuration section after providing a custom domain and saving the page once. +![Custom domain TXT configuration](/images/docs/images/status-pages/status-pages-custom-domain-3.png) @@ -40,7 +40,7 @@ The record can be copied from the Status Page configuration page after providing - Upload your company logo and the link it should direct to - Upload a custom favicon -- Choose the default theme between auto (system), light or dark theme +- Choose the default theme: auto (system), light or dark theme - Customize the color theme to match your brand diff --git a/communicate/status-pages/overview.mdx b/communicate/status-pages/overview.mdx index 0cfe4fe4..d7bf7b49 100644 --- a/communicate/status-pages/overview.mdx +++ b/communicate/status-pages/overview.mdx @@ -42,7 +42,7 @@ You can display the same service on multiple pages. An incident declared on that ### Connecting services and checks -Use [incident automation](/communicate/status-pages/incidents#incident-automation) to connect a service and a check to automatically open incidents for services based on check alerts. [See Incident automation for details](/communicate/status-pages/incidents#incident-automation). +Use incident automation to connect a service and a check to automatically open incidents for services based on check alerts. [See Incident automation for details](/communicate/status-pages/incidents#incident-automation). ## Best practices for status pages diff --git a/communicate/status-pages/subscriber-notifications.mdx b/communicate/status-pages/subscriber-notifications.mdx index 7e62d870..791a22a7 100644 --- a/communicate/status-pages/subscriber-notifications.mdx +++ b/communicate/status-pages/subscriber-notifications.mdx @@ -17,7 +17,7 @@ A verification email is sent to confirm their subscription. -From that moment on, subscribers will receive emails for incident updates and resolutions. They can choose to unsubscribe to these email at any time. +From that moment on, subscribers will receive emails for incident updates and resolutions. They can choose to unsubscribe to these emails at any time. @@ -52,5 +52,5 @@ Your Company Team If you've purchased a Communicate Starter or Communicate Team add-on, **extra subscribers will automatically be charged as overages**. You will receive an email notification about it, and can monitor your overages from [your Checkly account billing page](https://app.checklyhq.com/settings/account/billing). -If you have not purchased any Communicate add-on, we will continue accepting new subscribers to your page, yet will only send notifications to the first 250 subscribers. [View pricing for more details about limits](https://wwW.checklyhq.com/pricing). +If you have not purchased any Communicate add-on, we will continue accepting new subscribers to your page, yet will only send notifications to the first 250 subscribers. [View pricing for more details about limits](https://www.checklyhq.com/pricing). From dbcc6d80273564a58293ea2c5476e288379333c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Labas?= Date: Fri, 28 Nov 2025 14:11:02 +0100 Subject: [PATCH 5/8] fix: we actually don't send emails just yet --- communicate/status-pages/subscriber-notifications.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/communicate/status-pages/subscriber-notifications.mdx b/communicate/status-pages/subscriber-notifications.mdx index 791a22a7..440f40f7 100644 --- a/communicate/status-pages/subscriber-notifications.mdx +++ b/communicate/status-pages/subscriber-notifications.mdx @@ -50,7 +50,7 @@ Your Company Team ## How Checkly deals with subscribers limits based on your plan If you've purchased a Communicate Starter or Communicate Team add-on, **extra subscribers will automatically be charged as overages**. -You will receive an email notification about it, and can monitor your overages from [your Checkly account billing page](https://app.checklyhq.com/settings/account/billing). +You can monitor your overages from [your Checkly account billing page](https://app.checklyhq.com/settings/account/billing). If you have not purchased any Communicate add-on, we will continue accepting new subscribers to your page, yet will only send notifications to the first 250 subscribers. [View pricing for more details about limits](https://www.checklyhq.com/pricing). From 61d2cd01fc58ac6af26ab54fc18b7832c168da5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Labas?= <431257+thebiglabasky@users.noreply.github.com> Date: Mon, 1 Dec 2025 16:11:09 +0100 Subject: [PATCH 6/8] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: María de Antón --- .../status-pages/creating-a-status-page.mdx | 5 ++-- communicate/status-pages/customization.mdx | 23 ++++++++++--------- .../status-pages/subscriber-notifications.mdx | 14 +++++------ 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/communicate/status-pages/creating-a-status-page.mdx b/communicate/status-pages/creating-a-status-page.mdx index 829f9414..a45ab4f2 100644 --- a/communicate/status-pages/creating-a-status-page.mdx +++ b/communicate/status-pages/creating-a-status-page.mdx @@ -7,9 +7,8 @@ sidebarTitle: 'Creating a Status Page' To set up a Status Page, select ‘New status page’ on the [Status page overview](https://app.checklyhq.com/status-pages). 1. Begin by entering a name for your page. -2. Next, fill in the first **card**'s title and add services to it. Cards enable grouping **services** on your page and will show the average uptime for all the services listed on the card. -3. If you haven’t already created any service yet, you can do so from the `Services` dropdown by typing a name and clicking `Create`. See [Services](/communicate/status-pages/overview#services) for more details. -4. Customize the subdomain for your page. By default status pages will use the domain `.checkly-status-pages.com` but you can also use your own domain. See [Custom domains](/communicate/status-pages/customization#custom-domains) for more details. +2. Next, fill in the first **card title**. Now add or create services in it. Group several **services** on a single card to display the average uptime for all services listed in the card. For example, you can use one card per feature, and aggregate all services associated with the feature into a single card. +4. Customize the subdomain slug for your page. Status pages use the domain `.checkly-status-pages.com` by default. See [Custom domains](/communicate/status-pages/customization#custom-domains) for more details on how to use your own domain. 5. When you are happy with your setup, click ‘Create status page.’ You will now see a preview of your page, and a link to the public version of the page below the title. You can now share the link to your Status Page, and your users can subscribe to receive notifications when incidents are posted! diff --git a/communicate/status-pages/customization.mdx b/communicate/status-pages/customization.mdx index 86e27065..e788444c 100644 --- a/communicate/status-pages/customization.mdx +++ b/communicate/status-pages/customization.mdx @@ -7,40 +7,41 @@ sidebarTitle: 'Customization' ## Custom domain -Custom domains are available on Communicate Starter and higher plans. [View pricing](https://checklyhq.com/pricing) +Custom domains are available on Communicate Starter, Team and Enterprise plans. [View pricing](https://checklyhq.com/pricing) -You can host your Status Page under your own domain. To make this work, you need to do a few things: +You can host your Status Page on your own domain. To set it up, add the domain in Checkly and create the required DNS records with your DNS provider. - + ![Custom domain configuration](/images/docs/images/status-pages/status-pages-custom-domain-1.png) - -Any DNS provider will have the option to easily add CNAME records. For example on Cloudflare this looks as follows. + +Create a CNAME record with your DNS provider and point it to `custom-slug.checkly-status-page.com` +For example, in Cloudflare, the configuration looks like this: ![Custom domain CNAME configuration](/images/docs/images/status-pages/status-pages-custom-domain-2.png) If your provider is Cloudflare, you also need to disable the proxy on the CNAME, it should always be set to DNS only. - -The owner verification TXT record details can be copied from the Status Page configuration section page after providing a custom domain and saving the page once. + +Copy the domain-verification TXT record from the Status Page configuration after you've added your custom domain and save the page. -Your custom domain needs this verification in order for search engines to list your Status Page. +Search engines require this verification to index and list your Status Page. -The validation TXT record details can be copied from the Status Page configuration section after providing a custom domain and saving the page once. +Copy the validation TXT record(s) from the Status Page configuration after you've added your custom domain and save the page. ![Custom domain TXT configuration](/images/docs/images/status-pages/status-pages-custom-domain-3.png) ## Customize your Status Page to match your brand identity -- Upload your company logo and the link it should direct to +- Upload your company logo and the link it should open - Upload a custom favicon -- Choose the default theme: auto (system), light or dark theme +- Choose the default theme: auto (system), light or dark - Customize the color theme to match your brand diff --git a/communicate/status-pages/subscriber-notifications.mdx b/communicate/status-pages/subscriber-notifications.mdx index 440f40f7..264fbb91 100644 --- a/communicate/status-pages/subscriber-notifications.mdx +++ b/communicate/status-pages/subscriber-notifications.mdx @@ -5,23 +5,23 @@ sidebarTitle: 'Subscriber Notifications' --- ## Subscribing to incident updates -Your users can choose to be notified about any incident impacting your services by doing the following: +Users can choose to be notified about any incident impacting your services by subscribing through your Status Page. -By clicking the "Get updates" button at the top of the Status Page, users are directed to a form to fill in their email address. +To subscribe to notifications, users click the "Get updates" button at the top of the Status Page, and then fill out a form to enter their email address. - -A verification email is sent to confirm their subscription. + +A verification email is sent to the user's email address to confirm the subscription. -From that moment on, subscribers will receive emails for incident updates and resolutions. They can choose to unsubscribe to these emails at any time. +From that moment on, users with a confirmed subscription will receive emails for incident updates and resolutions. They can choose to unsubscribe from these emails at any time. -### Notification content structure +### Notifications content structure Here is an example of a Status Page notifications email: ```text @@ -50,7 +50,7 @@ Your Company Team ## How Checkly deals with subscribers limits based on your plan If you've purchased a Communicate Starter or Communicate Team add-on, **extra subscribers will automatically be charged as overages**. -You can monitor your overages from [your Checkly account billing page](https://app.checklyhq.com/settings/account/billing). +You can monitor your subscribers and overages from [your Checkly account billing page](https://app.checklyhq.com/settings/account/billing). If you have not purchased any Communicate add-on, we will continue accepting new subscribers to your page, yet will only send notifications to the first 250 subscribers. [View pricing for more details about limits](https://www.checklyhq.com/pricing). From e3194471601ee131868ec07258037b21ecfa2f38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Labas?= <431257+thebiglabasky@users.noreply.github.com> Date: Mon, 1 Dec 2025 16:11:49 +0100 Subject: [PATCH 7/8] Forgot DNS suggestions :/ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: María de Antón --- communicate/status-pages/customization.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/communicate/status-pages/customization.mdx b/communicate/status-pages/customization.mdx index e788444c..45db87c5 100644 --- a/communicate/status-pages/customization.mdx +++ b/communicate/status-pages/customization.mdx @@ -21,7 +21,7 @@ You can host your Status Page on your own domain. To set it up, add the domain i Create a CNAME record with your DNS provider and point it to `custom-slug.checkly-status-page.com` For example, in Cloudflare, the configuration looks like this: ![Custom domain CNAME configuration](/images/docs/images/status-pages/status-pages-custom-domain-2.png) -If your provider is Cloudflare, you also need to disable the proxy on the CNAME, it should always be set to DNS only. +If your provider is Cloudflare, you must disable the proxy on the CNAME, it should always be set to DNS only. From c4764c5f061cf25aa6f0dbfd36641698064c17fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Labas?= <431257+thebiglabasky@users.noreply.github.com> Date: Mon, 1 Dec 2025 17:10:56 +0100 Subject: [PATCH 8/8] Final changes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: María de Antón --- communicate/status-pages/subscriber-notifications.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/communicate/status-pages/subscriber-notifications.mdx b/communicate/status-pages/subscriber-notifications.mdx index 264fbb91..08a40f35 100644 --- a/communicate/status-pages/subscriber-notifications.mdx +++ b/communicate/status-pages/subscriber-notifications.mdx @@ -49,8 +49,8 @@ Your Company Team ## How Checkly deals with subscribers limits based on your plan -If you've purchased a Communicate Starter or Communicate Team add-on, **extra subscribers will automatically be charged as overages**. +To ensure your users can subscribe to your status page, **extra subscribers will be automatically billed as overages** once you've bought a Communicate Starter or Communicate Team add-on. You can monitor your subscribers and overages from [your Checkly account billing page](https://app.checklyhq.com/settings/account/billing). -If you have not purchased any Communicate add-on, we will continue accepting new subscribers to your page, yet will only send notifications to the first 250 subscribers. [View pricing for more details about limits](https://www.checklyhq.com/pricing). +If you have not purchased any Communicate add-on, we will continue accepting new subscribers to your page, yet will only send notifications to the first 250 subscribers. Once you upgrade to get more subscribers, those existing subscribers will start receiving notifications. [View pricing for more details about limits](https://www.checklyhq.com/pricing).