Squadcast Support

The Squadcast support Developer Hub

Welcome to the Squadcast support developer hub. You'll find comprehensive guides and documentation to help you start working with Squadcast support as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

StatusPage

Let your customers know how your service is doing without them having to ask you about it

What is StatusPage?

One of the core principles of SRE is Transparency and StatusPage helps you communicate the status of your services to your customers at all times as opposed to you getting to know the status of your service though support tickets logged by your customers.

We launched a preliminary version of StatusPage to address this. Now you can configure your public facing services and their dependent components and show their status in real time directly all from within Squadcast.

How it works?

You can configure the dependencies of your public facing services and then add them to StatusPage. You can configure the terminologies and the visual themes for Operational (Good) and Degraded (Bad).

Whenever the service has an incident, the status automatically goes to the status equivalent to Degraded (Bad) and when the incident gets resolved, the status of the service goes back to the Operational (Good) status or its equivalent status.

During an incident, you can choose to update the status of the incident directly from the Incident page by selecting the Update StatusPage option and update status like Acknowledged, Identified, Fix deployed, Resolved etc and accompany it with relevant description.

Adding a StatusPage

To add a StatusPage,

  1. Click on StatusPage from the Sidebar
  2. Click on the Add Status Page button.
  1. Enter a Name for the status page and enter the Domain / Sub-domain (eg: status.yourcompany.com or www.yourcompanystatus.com) where you want to host the status page under Page URL and copy the CNAME information and click on Save & Next button.
  1. In the Services Configuration page, select the services which you want to show in the page and provide a suitable Alias for them.

If the selected service is dependent on other services, then you can configure the service dependencies by selecting Dependencies from the service page and add the related services.

Setting CNAME record

When you try to view your StatusPage by clicking on the Status page or by visiting the configured URL, it won't be visible.

You need to setup the CNAME of the Domain / Sub-domain to point it to status.squadcast.io. This can be done from your DNS provider such as GoDaddy, AWS Route 53, DO or CloudFlare etc., wherever your DNS settings are located.

Customizing your StatusPage

Once, the CNAME is configured successfully. You can view the status page by clicking on its name from the StatusPage tab.

Update Header (Logo & Status Heading)

You can upload a Logo and change the default System status texts by clicking on the Edit Header.

Then upload a logo for your status page and provide custom text for Good Status (eg: Opertaional, All good! etc) and for the Bad Status as well (eg: Degraded, Oops.., Something is wrong etc.)

This status will update the page status in the header.

Configuring Service Status

You can also configure the Service status text and the colors by going to EditService Status.

Then you can customize the text on the right and you can edit the color on the left by clicking on the color and selecting from one of the displayed options or enter your own choice by providing the HEX value for that color.

You can see the changes reflecting in your screen by refreshing the screen.

Changing the colour theme

You can edit the color theme of your statuspage by clicking on EditTheme.

Then you can pick your colour from the visual colour picker or provide the colour values as either HEX, RGBA or HSLA and then click the Save button.

You can see the changes reflecting back as shown below.

Making your StatusPage public

Now that you are done with all the customizations, it's time to make the page public, so all your customers can view it.

To make a status page public, Go to Edit and check the Make Public check box as shown below.

Now anyone can publicly view the status page using the Public URL (say https://status.poniesareaweso.me)

Updating your StatusPage

Whenever there is an incident for a service, that service will be marked as Degraded / Bad and you can start updating the StatusPage with different status such as Acknowledged, Fixed, Deployed, Resolved etc., and add relevant information as description.

In order to do this, go to the Incident details page and click on the three dots on the top right of the incident and click on Update StatusPage.

Then in the Update StatusPage modal, enter the Custom Status and Custom Description, select the StatusPage and click on the Update button.

Markdown supported

Our StatusPage custom description supports markdown formatting.

These updates will be reflected in the public StatusPage.

Enable Subscriptions to your StatusPage

To enable subscriptions to your StatusPage, go to Edit, click on Subscriptions and check the Enable Subscriptions checkbox. This will now show up as a clickable button on your public StatusPage.

You can then include the modes of subscription you want to enable for your StatusPage.

You can add a suitable text on the sender's email address text box from which all the subscribed users will receive StatusPage update notifications. In this case, all the subscribed users will get mails from 'updates@status.poniesareaweso.me'

Note:

As of today, we support subscription via emails only. We will soon be including Webhook support as well.

StatusPage


Let your customers know how your service is doing without them having to ask you about it

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.