Integrate with Statuspage

What does the integration offer?

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

Statuspage sends webhook notifications on incident updates. With Statuspage Integration, every new incident creates an alert in Compass, and every update of the incident gets added as a Note to the existing alert. Compass acts as a dispatcher for these alerts, determines the right people to notify based on on-call schedules, notifies via email, text messages (SMS), phone calls, and iOS and Android push notifications, and escalates alerts until the alert is acknowledged or closed.
Compass creates an incident in Statuspage if a Compass action is mapped to a create an incident or create incident and update the components'/incident's statuses according to tags Statuspage action.
Compass resolves incidents in Statuspage if a Compass action is mapped to a resolve the incident or resolve the incident and update the components' statuses according to tags Statuspage action. Compass updates the incident in Statuspage if a Compass action is mapped to an add note to the incident Statuspage action.

How does the integration work?

When an incident is created in Statuspage, an alert will be created automatically in Compass.
When an incident is closed in Statuspage, the related alert will be closed automatically in Compass.

Set up the integration

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

Add a Statuspage integration in Compass
Map alert actions
Configure the integration in Statuspage

Add a Statuspage integration

In this release, only incoming integrations are fully supported in the Standard plan, at a team level. To use outgoing integrations or the outgoing part of bidirectional integrations, upgrade to a higher subscription plan. There may be restrictions on how you can create and apply integration rules as well.

You can add this integration only from your team’s operations page. Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team.

To add a Statuspage integration in Compass, complete the following steps:

Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Statuspage”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.
Expand the Steps to configure the integration section and copy the API URL.
You will use this key while configuring the integration in Statuspage later.
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

To configure the integration of Statuspage with Compass, complete the following steps:

In the Subscribers interface, select Options > Settings.
On the Subscriber Notification Settings modal, select “Webhook” for Delivery types.
Select Save Changes.
Go to your status page and select Subscribe To Updates.
Select webhook tab from the subscription dropdown.
Paste the URL copied previously into URL.
Enter your email address to receive emails when the API endpoint fails.
Select Subscribe To Notifications.

Configure the integration to update Statuspage

To configure the integration to update Statuspage back, complete the following steps:

Select your avatar in the bottom left of your Statuspage screen.
Select API info from the menu.
Copy the page ID for the page you want the integration to work for.
Navigate back to Compass and go to the Statuspage integration page.
Select Send Alert Updates Back to Statuspage or Create Statuspage Incidents for Compass Alerts checkbox as needed.
Paste the page ID into Statuspage Page Id field.
Paste the API key copied previously into Statuspage API Key.
Control what type of alerts is sent to Statuspage by using the Alert Filter.
Save the integration.

Compass attempts to verify the settings with Statuspage upon saving.

Map alert actions

Compass allows you to define action mappings between Compass actions and 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 Compass.
If Create Statuspage Incidents for Compass alerts is selected, actions for Statuspage are run when the chosen action is run in Compass 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 Compass 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 Compass action.

For alerts created by Statuspage

Map Compass 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 Compass actions to Statuspage actions. For example, update the Statuspage incident when a note is added to the Compass alert. To do this, define If a note is added to the alert in Compass, add note to the incident to the incident in Statuspage mapping in Send alert updates back to Statuspage section.

For other Compass alerts

Map Compass 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 Compass Alerts section.
Map one Compass action to create an incident or create an incident and update the components'/incident's statuses according to tags Statuspage action. The Compass 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 Compass 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.

Changing component/incident statuses via alert tags

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 Compass 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 Compass, 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 Compass, the statuses of the components/incident is changed according to the added tags.

To use component name:
Format the tags as cmp_[component name]:[status] where [component name] is the name of the component to have a status change. For example, cmp_API:degraded_performance.
To use component id:
Format the tags as cmpid_[component id]:[status] where [component id] is the id of the component to have a status change. For example, cmpid_componentId1:degraded_performance.
[status] is one of the allowed statuses for the component. These allowed statuses are listed below, under Allowed Component Statuses.

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

JSON

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

Operations