NAV

Introduction

Welcome to the documentation for the Statusy platform! You can find topics on the left side of the screen - if you have a particular question please try searching for it.

Have questions? Let us know

Getting Started

Statusy is a simple application for communicating the current status of your platform to your customers. Getting started is very easy and only takes a few steps.

Registration

You can register for a new account here. The registration process is straight forward, and you can make changes to everything that you enter here later.

Statusy Registration Page

The most important part of this form is your company name. This shows up on your public status page.

After you have submitted this form you will receive a confirmation email. Once you click on the confirmation link and log into your account you are ready to begin creating your status page.

Main Dashboard

Once you have confirmed your account and have logged in you will be redirected to the main application dashboard. This is where you will spend most of your time while using Statusy.

Statusy Dashbaord Image

Services

Services are the individual parts of your infrastructure that you want to display statuses for. This can be things like web hosts, database servers, API servers, and even external dependencies that your application relies on.

Clicking on the Add New Service button will allow you to add a new service. You can add as many services as you wish. You can always add, remove, or modify any services that you add here.

Open Incidents

Open Incidents display all of the current issues with your platform. This is where you will manage incidents when things go wrong.

Incident History

Incident History displays everything that has happened with your services over time. This will only show closed incidents.

Connecting to Twitter

Statusy has a Twitter integration built in which allows you to automatically update all of your Twitter followers any time that there is an incident. We recommend setting up a separate Twitter account for Status Notifications so that your users have an easy way of opting in to these sorts of updates.

In order to connect to your Twitter account, navigate to the Settings page and click on the Connect Twitter Button.

This will open up an authorization window on Twitter.

Twitter OAuth View

Sign in with your Twitter Account to grant access to Statusy. Once you have done this, Statusy will automatically tweet on your behalf whenever you open, update, or close an incident.

Custom Domain

You can have a custom domain name point to your public Status page. In order to do so, you will need to create a CNAME record.

  1. Log into whichever provider you use to manage DNS for your website.
  2. Add a new CNAME record to point to your public status page. For example if your statusy subdomain is acme.statusy.co and you want your custom url to be status.acme.com you would add the following CNAME record.

CNAME status.acme.com acme.statusy.co

After DNS propagates (which may take up to 48 hours) you will be able to navigate to status.acme.com and see your public status page.

User Profile

You can update your email address, password, and create new API keys from the User Profile view. In order to get to your profile select Account -> Profile from the main navigation.

User Profile View

Update Email Address

To change your email, enter a new address and select the Change Email button. You will need to click on the confirmation link at your new address before you can log in with your new email.

Update Password

To update your password, enter your current password and then your new password twice. Click on the Change Password button. This will take effect immediately.

Generate new API Token

You can create or regenerate an API token from the Profile view.

Team Management

You can invite an unlimited number of team members to join your Statusy team. Navigate to the team management view by selecting Account -> Team from the main navigation.

As shown below, you will see all of the current members of your team. There are two possible statuses:

1. Active - User has confirmed their account 2. Unconfirmed - User needs to accept their invitation by clicking on the link in the invitation email.

Team

Inviting a Team Member

Select the Invite Someone New button. Enter their email address and either press the Enter key or click on the Blue Envelope to send the invitation. You can also cancel out of this view by pressing the Escape key or clicking on the red x.

Deleting a Team Member

You can revoke access to your team by clicking on the red trash can icon next to the email address of the user that you wish to remove.

Billing

Free Preview

We offer an unlimited preview window that requires nothing more than your email to sign up.

During your preview you can do just about everything Statusy offers including add services, customize your status page, invite users to your account and so on.

The preview is meant to let you get a feel for what Statusy offers and make sure it is a great fit for you and your business or application!

Publish a status page

Once you are ready to release your brand new status page to the world you’ll need to purchase a subscription.

We believe in making things as simple as possible so we have one plan that is $15.00 USD per month.

You can purchase a subscription by clicking the Publish Status Page button on the dashboard.

DASHBOARDSS

From there you’ll be brought to a checkout screen. Here, you will have the opportunity to add a promotional code if you have one. If not, click “Pay with Card” to trigger the Stripe checkout screen.

Checkout

After you supply your credit card information click the “Pay $15.00” button to submit your order.

STRIPECHECKOUT

Once your order is completed you will see a summary of your order.

Order summary

Billing information

All of your billing information including your last payment amount, your renewal date and options to edit your subscription can be found on the billing page.

Billing information

Cancel subscription

You can cancel your subscription at any time on the billing page by clicking the “Cancel Subscription” button.

CANCELBUTTON

When a subscription is canceled, the cancellation date is set to the old paid through date of your subscription.

For example, if your subscription is paid through 01/01/2017 and you cancel your subscription on 12/12/2016 your subscription will remain active until 01/01/2017. Once 01/01/2017 has passed you will not be billed again and your subscription will cancel.

Restart subscription

If you have canceled your subscription previously and would like to continue using a Statusy status page you can restart your subscription at any time on the billing page.

One of two things will happen from there - if your paid through date is still in the future your subscription will be automatically reactivated without further payment. You will be billed again on your paid through date as shown on the billing page.

If your subscription’s paid through date is in the past you will see the checkout screen as shown above and you will need to enter your credit card information again.

Frequently Asked Questions

What forms of payment do you accept?

We accept all major credit cards: Visa, Mastercard, American Express and Discover. All of our payments are handled securely through Stripe checkout.

What does a subscription include?

Everything - we do not have multiple plans to keep things simple.

Can I cancel my subscription any time?

Yes, but if you have time left on your subscription it will remain active until that time is up.

Do you offer refunds?

As a general rule, no we do not. However, in the event of extenuating circumstances we are happy to consider offering a refund.

Are there any other fees?

Nope, its $15.00 per month, simple as that.

My question isn’t answered here, how can I ask it?

You can contact us at billing@statusy.co with any concerns or questions.

Using the API

Statusy has a fully functional RESTful API. When using the API be sure to check out the API Documentation.

In order to use the API you must first create a token. API Tokens are issued at the user level.

API Token Generation

  1. Navigate to your profile page.
  2. Select the Generate API Token Button.
  3. Copy the token and put it somewhere safe. Once you navigate away from the page you will not be able to see the token again.

You can generate a new token at any time by clicking on the Generate API Token button. This will remove the previous token that was associated with your user.

If you wish to disable API access via a token completely select the Deactivate API Token button.

Support

We currently provide all support via email. You can contact support by emailing support@statusy.co.

You are welcome to send any questions you may have via email and we will respond to you as soon as we can.