Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel3
outlinefalse
typelist
printablefalse

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 a 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 a 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 a Jira Service Management action is mapped to an add note to the incident Atlassian Statuspage action.

How does the integration work?

  • 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 selectd, 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 a Jira Service Management action.

...

Set up the integration

Statuspage is a bidirectional integration. Setting it up involves the following steps:

  • Add a Statuspage integration in Jira Service Management

  • Map alert actions

  • Configure the integration in Statuspage

Add Statuspage integration

...

  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  or Create Statuspage Incidents for Jira Service Management Alerts check boxcheckbox as needed.

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

  7. In Statuspage, copy the API key and paste in it into 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.

Map alert actions

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

  • If Send alert updates back to Statuspage is selected, actions for Statuspage are run in Statuspage when the chosen action is run in Jira Service Management.

  • If Create Statuspage Incidents for Jira Service Management alerts is selected, actions for Statuspage are run when the chosen action is run in Jira Service Management for alerts with 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 are 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 are changed to Operational when applicable if a resolve incident and update components' statuses according to tags Statuspage action is mapped to a Jira Service Management action.

Expand
titleFor alerts created by Statuspage

...

  • Map Jira Service Management actions to

...

  • Statuspage actions when the source of the alert is

...

  • StatusPage (

...

  • that is, the alert is created by

...

  • StatusPage integration

...

  • ) in the Send alert updates back to Statuspage section.

  • Map

...

  • Jira Service Management actions to

...

  • Statuspage actions. For example, update the

...

  • Statuspage incident when a note is added to the Jira Service Management alert.

...

  • 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

...

  • Statuspage mapping in Send

...

  • alert updates back to Statuspage section.

Expand
titleFor other Jira Service Management alerts

...

  • Map Jira Service Management actions to

...

  • Statuspage actions when the source of the alert is NOT

...

  • Statuspage (

...

  • that is when the alert is created by another integration

...

  • ) in the Create Statuspage Incidents for Jira Service Management Alerts

...

  • section.

  • Map one Jira Service Management action to create an incident or create an incident and update the components'/incident's statuses according to tags

...

  • 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 the other actions. When

...

  • either action 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

...

  • 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 can't be left empty.

  • For mapping

...

  • a 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

...

  • differ by the given tags and the given custom action names.

Expand
titleChanging

...

component/

...

incident statuses via alert tags

This is an optional step.

  • Change the statuses of the components/incident in Statuspage by adding

...

  • specially formatted tags to the alert.

...

  • You can add tags while creating the alert or after. If a 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

...

  • is created in Statuspage and the statuses of the components and the incident

...

  • are changed according to the specially formatted tags. Or if a tag is added to the

...

  • alert action is mapped

...

  • to 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

...

  • is 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.

...

  • Learn more about allowed statuses

...

  • . The following are the allowed statuses:

    • operational

    • degraded_performance

    • partial_outage

    • major_outage

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

...

  • The following

...

  • are some examples:

    • cmp_API:degraded_performance

    • cmp_Database Server:partial_outage

    • cmp_Management Portal:operational

    • inc:monitoring

    • inc:identified

  • The statuses of the components given in tags are changed to Operational in

...

  • Statuspage if

...

  • a Jira Service Management action is mapped to a resolve the incident and update the components' statuses according to tags

...

  • Statuspage action.

Allowed component statuses

  • operational

  • degraded_performance

  • partial_outage

  • major_outage

...

  • The following are some allowed incident statuses:

    • investigating

    • identified

    • monitoring

    • resolved

...

Examples

...

cmp_API:degraded_performance

...

cmp_Database Server:partial_outage

...

cmp_Management Portal:operational

...

inc:monitoring

...

Sample payload sent from Statuspage

Expand
titleSample payload in JSON format
Code Block
{
  "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"
      }
    ]
  }
}

...