Versions Compared

Old Version 4

changes.mady.by.user Shivi Sivasubramanian

Saved on

compared with

New Version Current

changes.mady.by.user Shivi Sivasubramanian

Saved on

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?

...

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

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

  7. In Statuspage, copy the API key and paste 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 StatusPage actions.

...

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.

  • The following are some allowed incident statuses:

    • investigating

    • identified

    • monitoring

    • resolved

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"
      }
    ]
  }
}

...