Configuring StatusPage.io

Atlassian StatusPage.io is a status page platform for your app, web service or developer API. The integration allows you to push alerts and metrics to their platform, and we have worked together to make the integration seamless. To get started, you will first need to set up a StatusPage account at https://statuspage.io/. Uptime.com requires the following:

  • Page ID
  • API Key
  • Component ID or Metric ID

Integration Functionality

Integration with Atlassian StatusPage allows for the following:

  • When an alert is created in Uptime, an alert is created in StatusPage automatically through the integration.
  • When the alert is cleared on Uptime, the related alert is closed in StatusPage.
  • Check response time metrics from Uptime.com within StatusPage.io
  • Metrics will appear in 15-minute intervals

Integration Setup

Log into StatusPage, click on your profile and Manage Account. Click the API tab, and copy your Page ID and your API Key. 

PageIDAPI-2.png

Next, you need to retrieve either your Component ID and/or your Metric ID.

To update a Component with alerts, click Components and find the Component ID by hovering over the Edit link. (The Component ID is the last part of the URL, e.g. "y0jf83vrf5qb").

Component-ID.png

To update a Public Metric with response times, click on Public Metrics, then Edit the metric. Click the Advanced Options tab and copy the Metric ID.

Return to Uptime.com, then click Notifications followed by Integrations. Click New Profile, then select StatusPage as the Provider Type.

Paste the Page ID and API Key into the appropriate fields. Then paste either the Component ID or Metric ID depending on what you choose.

The following describes the fields shown when configuring StatusPage within your Uptime account:

  • Name: The reference name you desire to assign to your Statuspage profile. It can assist you in organizing multiple integration provider profiles within your Uptime account.
  • API Key:  This will be obtained from StatusPage. Please review the Obtaining StatusPage API Key section below for further documentation.
  • Page ID: This will be obtained from StatusPage. Please review the Obtaining StatusPage Page ID screenshot above for more information.
  • Component ID
  • Metric ID

status-page-io.png

Once you've configured your StatusPage integration, you will need to assign it to a contact and make sure that contact is notified when a Check fails.

Assign Integration to Existing Contacts

To add your integration to an existing contact, click on or type the name of the contact into the Assign to Contacts field within the integration setup screen.

contacts.png

Create New Contacts for the Integration

Adding a dedicated or new contact cannot be done within the integrations screen. To do so first, click Notifications>Contacts. You can select New Contact, or add your integration to an existing contact.

Select StatusPage from the Push Notifications field within the New Contact screen.

Assign Integration Contact to a Check

If you have created a new or dedicated contact for your integration, you will need to add it to specific checks. If you have assigned the integration to a contact that is already assigned to one (or more) checks, you may skip this step.

Return to your Check’s Edit screen and assign this contact to the Contacts field to be notified of a downtime event. Metrics will appear in 15-minute intervals. On initial setup, metric data may take up to 30 minutes to initially appear.

Data for one or five-minute interval checks is shown in averages of 15 minutes, with more precise metrics and the option to download metrics available from Uptime.com. This data also includes response time per location.

Please note: Response time data is stored based on plan usage. Uptime.com stores hourly data for a maximum of 90 days, and daily check data for a period of up to 24 months.

Test Your Integration

Test your integration with one of the following two options:

  1. Force the Check assigned to your Integration to fail by altering it (HTTPS checks can use a misspelling of the domain, for example)
  2. Click Notifications>Contacts, then click Actions>Test to send a test to the Contact

 Test.png