Statuspage.io is a great product for publicizing incidents that are currently occurring with your product. We use them, as well as thousands of other companies. It makes sense to integrate your public status page updates into an incident response process, so we built our Statuspage.io integration to do just that. This guide goes over how to setup and use the integration.
You'll need to be logged in as an owner on FireHydrant and also be logged into your statuspage.io account.
First, you'll need to grab an API token from your Statuspage account, you can do this by logging in, and clicking on your name and profile photo in the top right. Click "Manage account".
From here, head to the API tab, and copy the "User API key" that is shown to you.
Go to app.firehydrant.io
Next, we're going to configure the integration inside of FireHydrant so we can create incidents and post updates on statuspage with the API key you just copied to your clipboard.
Click Integrations under the Organization navigation menu. From there click "Setup Statuspage" in the list.
On the page, you'll see a single form input to add your API key that you copied. Paste it in, and click Save.
After clicking save, you'll see a page appear that will allow you to link your Statuspage components to FireHydrant functionalities.
This step is important if you want to display which components are currently broken to visitors on your Statuspage URL. FireHydrant uses these links to properly add and update components on your Statuspage.
If you want to create functionalities inside of FireHydrant, leave the default "Create New" option selected. Otherwise, you may want to link to previously existing functionalities inside of FireHydrant.
Next, we need to configure the default page
FireHydrant needs to know which status page we will create updates on, to do this head back to the Integrations page and click "Configure Integration".
On this page, you'll see a dropdown to select which page in which FireHydrant will send incident information to. Select the page you'd like to post to.
Note: At this time FireHydrant only supports one statuspage as a target.
You'll also see the option to map severities to the impact on Statuspage.io. FireHydrant allows its users to customize the severities in its system, and Statuspage has a more finite set of impacts, so you may want to customize how your severities map to impact displayed to customers publicly.
Save your settings to enable the full power of the integration. You won't be able to create statuspage incidents from FireHydrant unless a default page is selected at a minimum.
Once you've performed the above steps, you'll have an option to create a Statuspage incident from FireHydrant's incident page, seen below.
This will quickly create an incident on your configured Statuspage account and set the correct impact based on the severity of your FireHydrant incident.
If you linked Statuspage components to FireHydrant functionalities, we'll automatically add those to the incident when you add them to your incident.
And here it is added to the public incident status.
As you transition through your incident milestones on FireHydrant, we'll also update the public status, too. For example, if you set "Mitigated" on FireHydrant, we'll post a "Monitoring" update on Statuspage. When you resolve an incident, naturally, we'll resolve it on Statuspage too.
On your timeline, you can add public notes as well! These will get added to your public facing page when you select the "Public" visibility.
Which results in a nicely updated page almost instantly!
That's it! If you have any questions, always feel free to email us at firstname.lastname@example.org