Integrate with StatusPage

Overview

What does the integration offer?

Statuspage lets service providers add a component for each of the separate infrastructure or functional part of their service. Jira Service Management has a powerful two-way integration with Statuspage. The integration is used as follows:

1. Statuspage sends webhook notifications on incident updates. With Atlassian Statuspage Integration, every new incident creates an alert in Jira Service Management, and every update of the incident gets added as a Note to the existing alert. Jira Service Management acts as a dispatcher for these alerts, determines the right people to notify based on on-call schedules– notifying them using email, text messages (SMS), phone calls and iOS & Android push notifications, and escalates alerts until the alert is acknowledged or closed.

2. Jira Service Management creates an incident in Atlassian Statuspage if an Jira Service Management action is mapped to a create an incident or create incident and update the components'/incident's statuses according to tags Atlassian Statuspage action.

3. Jira Service Management resolves incidents in Atlassian Statuspage if an Jira Service Management action is mapped to a resolve the incident or resolve the incident and update the components' statuses according to tags Atlassian Statuspage action. Jira Service Management updates the incident in Atlassian Statuspage if an Jira Service Management action is mapped to an add note to the incident Atlassian Statuspage action.

Functionality of the integration

• When an incident is created in Statuspage, an alert will be created automatically in Jira Service Management.

• When an incident is closed in Statuspage, the related alert will be closed automatically in Jira Service Management.

Action Mapping

• If Send Alert Updates Back to Atlassian Statuspage is enabled, actions for Statuspage are executed in Statuspage when the chosen action is executed in Jira Service Management.

• If Create Atlassian Statuspage Incidents for Jira Service Management Alerts is enabled, actions for Statuspage will be run when the chosen action is executed in Jira Service Management for alerts that have a source other than the Statuspage integration.

• When a specially formatted tag is added to the alert, the statuses of the components/incident in Statuspage will be changed to the given status, if an update components'/incident's statuses according to added tags Statuspage action is mapped to a tag is added to the alert Jira Service Management action.

• The statuses of the components given in the tags will be changed to Operational, when applicable if a resolve incident and update components' statuses according to tags Statuspage action is mapped to an Jira Service Management action.

These action mapping features are explained in detail in the Action Mapping section on this page.

Add Statuspage integration

To add a Statuspage integration in Jira Service Management:

1. Go to your team’s operations page.

2. On the left navigation panel, select Integrations and then Add integration.

3. Run a search and select “Statuspage”.

4. On the next screen, enter a name for the integration.

5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

6. Select Continue.
   The integration is saved at this point.

7. Expand the Steps to configure the integration section and copy the URL.
   You will use this URL while configuring the integration in Statuspage later.

8. Select Turn on integration.
   The rules you create for the integration will work only if you turn on the integration.

Configure the integration in Statuspage

1. In the Subscribers interface, select Options > Settings.

2. On the Subscriber Notification Settings modal, select “Webhook” for Delivery types.

3. Select Save Changes.

4. Go to your status page and select Subscribe To Updates.

5. Select webhook tab from the subscription dropdown.

6. Paste the URL you copied while adding the integration in Jira Service Management into URL.

7. Enter your email address to receive emails when the API endpoint fails.

8. Select Subscribe To Notifications.

Configure the integration to update Statuspage

1. Select your avatar in the bottom left of your Statuspage screen.

2. Select API info from the menu.

3. Copy the page ID for the page you want the integration to work for.

4. Navigate back to Jira Service Management and go to the Statuspage integration page.

5. Select Send Alert Updates Back to Statuspage and/or Create Statuspage Incidents for Jira Service Management Alerts check box.

6. Paste the page ID into Statuspage Page Id field.

7. In Statuspage, copy the API key and paste in the Statuspage API Key field.

8. Control what type of alerts is sent to Statuspage by using the Alert Filter.

9. Save the integration.

Jira Service Management attempts to verify the settings with Statuspage upon saving.

Action mapping

Jira Service Management allows you to define action mappings between Jira Service Management actions and Atlassian StatusPage actions.

For alerts created by Statuspage

• Use this section to map Jira Service Management actions to Atlassian Statuspage actions when the source of the alert is Atlassian StatusPage (i.e When the alert is created by Atlassian StatusPage integration.)

• Map different Jira Service Management actions to different Atlassian Statuspage actions. For example, update the Atlassian Statuspage incident when a note is added to the Jira Service Management alert. In order to do this, define If a note is added to the alert in Jira Service Management, add note to the incident to the incident in Atlassian Statuspage mapping in Send Alert Updates Back to Atlassian Statuspage section.

For other Jira Service Management alerts

• Use this section to map Jira Service Management actions to Atlassian Statuspage actions when the source of the alert is NOT Atlassian Statuspage (i.e When the alert is created by another integration.)

• For this purpose, use Create Atlassian Statuspage Incidents for Jira Service Management Alerts section. In order to use this functionality, map one Jira Service Management action to create an incident or create an incident and update the components'/incident's statuses according to tags Atlassian Statuspage action. The Jira Service Management action doesn't have to be alert is created, it can be other actions as well.

• a tag is added to the alert and a custom action is executed on alert actions differ from other actions. When one of these actions is selected, an extra field appears to enter which tags or for which custom action this mapping works.

• Enter multiple tags by separating them with a comma. If multiple tags are entered, the mapping works if the alert has one or more of the specified tags. Leave the tags field empty for the mapping to work for any tag.

• Specify the name of the custom action for custom mappings. It cannot be left empty.

• For mapping an Jira Service Management action to multiple Statuspage actions, an error occurs except for the a tag is added to the alert and a custom action is executed on alert actions. Save multiple mappings for these actions because they will differ by the given tags and the given custom action names.

Changing Component/Incident Statuses via Alert Tags (Optional)

• Change the statuses of the components/incident in Statuspage by adding some specially formatted tags to the alert.

• These tags are added at the creation of the alert or can be added after creating the alert. If an Jira Service Management action is mapped to create an incident and update the components'/incident's statuses according to tags Statuspage action, when an alert with specially formatted tags is created in Jira Service Management, an incident will be created in Statuspage and the statuses of the components and the incident will be changed according to the specially formatted tags. Or if a tag is added to the alert Opsgenie action is mapped to an update the components'/incident's statuses according to added tags Statuspage action, when a specially formatted tag is added to the alert in Jira Service Management, the statuses of the components/incident will be changed according to the added tags.

• Format the tags as cmp_[component name]:[status] where [component name] is the name of the component to have a status change and [status] is one of the allowed statuses for the component. These allowed statuses are listed below, under the Allowed Component Statuses header.

• Change the statuses of multiple components by adding a separate status tag for each component. Check the following examples.

• The statuses of the components given in tags are changed to Operational in Atlassian Statuspage if an Jira Service Management action is mapped to a resolve the incident and update the components' statuses according to tags Atlassian Statuspage action.

Allowed Component Statuses

• operational

• degraded_performance

• partial_outage

• major_outage

Allowed Incident Statuses

• investigating

• identified

• monitoring

• resolved

Examples

• cmp_API:degraded_performance

• cmp_Database Server:partial_outage

• cmp_Management Portal:operational

• inc:monitoring

• inc:identified

Sample payload sent from Statuspage

{
  "meta":
  {
    "unsubscribe": "https://jsmtest.statuspage.io/?unsubscribe=8rx45n6txwh3",
    "documentation": "http://doers.statuspage.io/customer-notifications/webhooks/"
  },
  "page":
  {
    "id": "1k9dvd5q1qlv",
    "status_indicator": "none",
    "status_description": "All Systems Operational"
  },
  "incident":
  {
    "name": "incident1",
    "status": "investigating",
    "created_at": "2015-10-08T13:13:53.303Z",
    "updated_at": "2015-10-08T13:13:53.558Z",
    "monitoring_at": null,
    "resolved_at": null,
    "impact": "none",
    "shortlink": "http://stspg.io/1Z1G",
    "postmortem_ignored": false,
    "postmortem_body": null,
    "postmortem_body_last_updated_at": null,
    "postmortem_published_at": null,
    "postmortem_notified_subscribers": false,
    "postmortem_notified_twitter": false,
    "backfilled": false,
    "scheduled_for": null,
    "scheduled_until": null,
    "scheduled_remind_prior": false,
    "scheduled_reminded_at": null,
    "impact_override": null,
    "scheduled_auto_in_progress": false,
    "scheduled_auto_completed": false,
    "id": "hk801ps7x9x4",
    "page_id": "1k9dvd5q1qlv",
    "incident_updates":
    [
      {
        "status": "investigating",
        "body": "this is a test incident",
        "created_at": "2015-10-08T13:13:53.556Z",
        "wants_twitter_update": false,
        "twitter_updated_at": null,
        "updated_at": "2015-10-08T13:13:53.556Z",
        "display_at": "2015-10-08T13:13:53.556Z",
        "id": "7m0y35xlqh8j",
        "incident_id": "hk801ps7x9x4"
      }
    ]
  }
}