StatusDashboard Documentation

StatusDashboard is a powerful communications platform that allows companies of all sizes to easily communicate system status to their customers, wherever they are.  Within our documentation, you'll find everything you need to get up and running on StatusDashboard.

If you are a new user, we've put together some helpful information and links below that will quickly get you started configuring and using StatusDashboard.

Dashboard URL

When you sign up for a StatusDashboard account, you request a unique subdomain URL for hosting your status dashboard (e.g. acme.statusdashboard.com).  As soon as your account is created, this URL is live and you are free to provide it to your users and customers.  You can also change the dashboard URL at any time.  You also have the option of setting up a domain alias from which to host your status dashboard. This is a custom URL in your DNS zone (e.g. status.acme.com).

Services

Services are the systems that you want to display and report on with your status dashboard - these could be websites, APIs, servers, or anything else about which your users and customer require timely status information.  One of the first things you'll want to do when setting up your status dashboard is add some services.  Once you add services, they'll immediately be available on your status dashboard and don't worry, you can always change the names or descriptions later.

Events

Events are one of the foundational features of StatusDashboard.  You create events in StatusDashboard whenever any of the services on your dashboard experience a degredation of service, whether planned (incident) or unplanned (scheduled maintenance).  When events are created, your dashboard is automatically updated and you have the option of broadcasting notifications (like email and SMS) to any of your users who have opted in to receive them.  Events have a standard lifecycle which helps to keep your users informed about their status (e.g. investigating => identified => monitoring => resolved).  To get started with creating and managing events effectively, make sure you read our best practices guide to managing events.

Uptime Reports

Many service providers have SLA commitments with their customers that require their systems to maintain a certain amount of uptime during a given month or year.  When you use StatusDashboard to track all incidents and scheduled maintenance activities, we become the system of record for your official uptime metrics.  Utilizing our reporting tools, you can quickly and easily create uptime reports across any time period to calculate system uptime.  Uptime reports also allow you to quickly determine which events impacted system uptime.

Security

We have a number of security options available to help you secure both the StatusDashboard administration console and your dashboard pages.  By default, your dashboard subdomain is served securely over SSL and if you choose to setup a domain alias, we can also serve that over SSL.  You can also log all activity within the administration console, create a dashboard IP whitelist, an administration console IP whitelist or an email domain whitelist.  Additionally, if you would like to itegrate your Identity Provider (IdP) with StatusDashboard for administrative or dashboard authentication, we have a full suite of SSO configuration options.

Digital Signs

Digital signs are meant to display status information for one or more services on a large digital signage display (e.g. a large wall mounted television in a lobby or network operations control center).  Digital signs are best run in a browser that is operating in full screen or kiosk mode and are run completely unattended (they will automatically refresh and update as status information changes).  Multiple digital signs may be created containing different services and customization settings to accommodate each customer's unique needs.

Dashboard Options

There are many StatusDashboard configuration options that allow you to modify how the dashboard looks and what information it displays.  For example, you can add different content modules to the home page to provide detailed information on upcoming scheduled maintenance activities or active incidents.  You can also group services using criteria that you define or change the main dashboard display between a week long calendar view or a more standard operational view.

Dashboard Design

It is important for most customers to have a status dashboard that matches the look and feel of their organization and its existing web properties.  We provide you with tools that allow you full control over the look and feel of your dashboard.  Add your own custom style by setting up custom colors, uploading your company logo and customizing the footer.

System Messages

Create a system message to inform your users about the purpose of your status dashboard and to set their expectations about how and when you will update it.  The system message is shown directly above your status dashboard and is a great way to communicate important messages to your users and customers.

Notifications

Whenever events impact any of the services on your dashboard, you have the option of broadcasting notifications to your users and customers with information about the event.  Customers are able to manage their own subscription preferences so they only receive the notifications relevant to them, via the channels they desire.  StatusDashboard supports many different notification channels including API, Email, HipChat, RSS, Slack, SMS, Twitter and Webhooks.

User Accounts

Depending on the StatusDashboard plan that you subscribe to, we provide you with one or more administrative user accounts with which to manage your status dashboard.  You have the ability to add and manage user accounts, including granular user permissions for StatusDashboard administrators.  We also have options to integrate user authentication with your identity provider via the SAML protocol or Google OAuth.

Account Activation

If you choose to convert your account to one of our paid plans, we have several different options to choose from.  If you require a custom configuration that is not available on one of our existing plans, please contact us - we are able to easily create a custom feature and pricing plan that suits your organization.  We also have several different payment options available including credit card, invoice/purchase order and wire transfer/direct deposit.

Still have questions?  Contact our support team.  We're always happy to help with any questions you might have.