Administer PostmanIntegrationsPostman integrations

Integrate Postman with Statuspage

View as Markdown

Atlassian’s Statuspage is an uptime and incident communication tool. 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. Customers can also use the home page to find out more information on system outages or failures. An 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. When configuring the integration, you can choose to link a monitor to a Statuspage component, create a Statuspage incident when a monitoring run fails, or both.

Before you begin, create your Statuspage account, page, and components.

Retrieve your Statuspage API key

  1. Sign in to Statuspage.
  2. Click your avatar and click API info.
  3. Click Create key to create a new key, or find an existing key you want to use.
  4. Copy the API key for later use.

Configuring the Statuspage integration

  1. From the Home page, click Integrations.
  2. Click Browse All Integrations.
  3. Search for and select Statuspage.
  4. Click Add Integration.
  5. In the Authenticate tab, enter the Statuspage API key you copied in the Retrieving your Statuspage API key section. Then, click Authenticate and Proceed.
  6. In the Configure tab, enter a nickname for the integration.
  7. Select the workspace that has the monitor you want to use.
  8. Select the monitor you want to use for the integration.
  9. Select the Statuspage page where the monitor updates will be sent.
  10. Select one or both Statuspage actions. See Linking a monitor to a component and Creating an incident when a monitoring run fails for more information.
  11. Click Add Integration.

You can view your configured integrations on the Browse Integrations page. If any other integrations have been configured for that same monitor, you’ll see an Integrations label with a number in parentheses that indicates the number of integrations already configured for that monitor, click the label to view the integrations. Learn more about viewing or editing integrations.

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

To configure the Link monitor to component action, do the following:

  1. Select the Statuspage component you want to link to the monitor.
  2. Select a component success status. This status is displayed in Statuspage when the linked monitor runs as expected.
  3. Select a component failure status. This status is displayed in Statuspage when the linked monitor fails a test run.

When the monitor fails, the linked component’s status changes on your status page:

When a component’s status changes due to a failed test run, it remains in that state until there is a successful test run in the monitor. After a successful run, the component status returns to the successful state.

Create an incident when a monitoring run fails

When the Create incident when monitoring run fails 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.

To configure the Create incident when monitoring run fails action, do the following:

  1. Enter an incident name. The name is shown to users when they view the incident.
  2. Select an incident status. The status is shown to users when they view the incident.
  3. Select an incident impact. Choose an impact based on the importance of the service you’re monitoring. For example, the failure of an optional, low-traffic API could trigger a minor incident, but the failure of your main authentication API would have critical impact.

When the monitor fails, an incident is created on your status page.

When an incident is created by a failed test run, if a later test run is successful, the incident is closed.