Statuspage

Integrations are available on Postman Team, Business, and Enterprise plans.

Atlassian Statuspage an uptime and incident communication tools. You can use Statuspage to create a home page for your customers so they can monitor if subsystems or services within your site are operational, and find out more information on system outages or failures. A great example of a Statuspage home page is Postman's status page, located at status.postman.com.

The Statuspage integration enables you to send metrics like response times to Statuspage and create and communicate incidents in case of a failure. When a Postman monitor test run fails, this integration can then send updates to Statuspage.

Setting up a Statuspage integration requires you to get an API key from Statuspage, and configure if a monitor is linked to a Statuspage component, if a monitoring run failure creates a Statuspage incident, or both.

Make sure to create your Statuspage account and create a page and components before you begin. For more information, visit Atlassian's Statuspage page.

Retrieving your Statuspage API Key

  1. Log in to Statuspage.
  2. Click your avatar icon in the bottom left of the page.
  3. On the user menu, select API info. Statuspage API key
  4. Click Create key to create a new key, or find an existing key you want to use.
  5. Copy the API key for later use.

Integration Setup

  1. On your Home page, navigate to Integrations, click Browse All Integrations, and click Statuspage in the list of third-party integrations.
  2. Click Add Integration.
  3. In the Authenticate tab, enter the Statuspage API key you copied above. Statuspage add integration
  4. Click Authenticate and Proceed. The Configure tab is shown.
  5. Enter a nickname for the integration.
  6. Select a workspace from the list which contains the monitor you would like to use.
  7. Select the monitor you wish to use from the list.
  8. Select a Statuspage page where the monitor updates will be sent. This list will be populated with the pages you have created in Statuspage.
  9. Select one or both Statuspage actions. See Link monitor to component and Create incident when monitoring run fails for information on how to fill in these sections. Configure Statuspage
  10. Click the Add Integration button.

When this action is configured, if the specified monitor fails a test run, it will change the status of the linked component.

If you select the Link a monitor to a component action, enter the following:

  1. Select a component from the list. The list will be populated with the components you have created in Statuspage.
  2. Select a component success status from the list. This status will be displayed in Statuspage when the linked monitor is running normally.
  3. Select a component failure status from the list. This status will be displayed in Statuspage when the linked monitor fails a test run. Statuspage link monitor to component

When the monitor fails, the linked component's status will change on your status page:

Statuspage component failure

When a component's status is changed due to a failed test run, it will remain in that state until there is a successful test run in the monitor. After a successful run, the component status will return to the successful state.

Create incident when monitoring run fails

When this action is configured, if the specified monitor fails a test run, a Statuspage incident is created. The incident provides context to customers on why the failure happened, and what will be done to address it.

If you select the Create incident when monitoring run fails action, enter the following:

  1. Enter a name for the incident name. This is the text shown to customers when they see the incident.
  2. Select an Incident status from the list.
  3. Select an Incident impact from the list. You can set this according to the importance of the service you are monitoring. For example, the failure of an optional, seldom-used API could trigger a minor incident, but the failure of your main authentication API would have critical impact. Statuspage create incident

When the monitor fails, an incident will be created on your status page:

Statuspage incident

When an incident is created by a failed test run, if a successive test run finishes successfully, the incident will be closed.