Skip to main content

Check out Port for yourself 

Statuspage

Port's Statuspage integration allows you to model Statuspage resources in your software catalog and ingest data into them.

Overview​

This integration allows you to:

  • Map and organize your desired Statuspage resources and their metadata in Port (see supported resources below).
  • Watch for Statuspage object changes (create/update/delete) in real-time, and automatically apply the changes to your entities in Port.

Supported Resources​

The resources that can be ingested from Statuspage into Port are listed below. It is possible to reference any field that appears in the API responses linked below in the mapping configuration.

Setup​

Choose one of the following installation methods:

Using this installation option means that the integration will be hosted by Port, with a customizable resync interval to ingest data into Port.

Live event support

Currently, live events are not supported for this integration.
Resyncs will be performed periodically (with a configurable interval), or manually triggered by you via Port's UI.

Therefore, real-time events (including GitOps) will not be ingested into Port immediately.
Live events support for this integration is WIP and will be supported in the near future.

Self-hosted installation

Alternatively, you can install the integration using the Real-time (self-hosted) method to update Port in real time using webhooks.

Installation

To install, follow these steps:

  1. Go to the Data sources page of your portal.

  2. Click on the + Data source button in the top-right corner.

  3. Click on the relevant integration in the list.

  4. Under Select your installation method, choose Hosted by Port.

  5. Configure the integration settings and application settings as you wish (see below for details).

Application settings

Every integration hosted by Port has the following customizable application settings, which are configurable after installation:

  • Resync interval: The frequency at which Port will ingest data from the integration. There are various options available, ranging from every 1 hour to once a day.

  • Send raw data examples: A boolean toggle (enabled by default). If enabled, raw data examples will be sent from the integration to Port. These examples are used when testing your mapping configuration, they allow you to run your jq expressions against real data and see the results.

Integration settings

Every integration has its own tool-specific settings, under the Integration settings section.
Each of these settings has an ⓘ icon next to it, which you can hover over to see a description of the setting.

Port secrets

Some integration settings require sensitive pieces of data, such as tokens.
For these settings, Port secrets will be used, ensuring that your sensitive data is encrypted and secure.

When filling in such a setting, its value will be obscured (shown as ••••••••).
For each such setting, Port will automatically create a secret in your organization.

To see all secrets in your organization, follow these steps.

Limitations

  • The maximum time for a full sync to run is based on the configured resync interval. For very large amounts of data where a resync operation is expected to take longer, please use a longer interval.

Port source IP addresses

When using this installation method, Port will make outbound calls to your 3rd-party applications from static IP addresses.
You may need to add these addresses to your allowlist, in order to allow Port to interact with the integrated service:

54.73.167.226  
63.33.143.237  
54.76.185.219

Configuration​

Port integrations use a YAML mapping block to ingest data from the third-party api into Port.

The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.

Default mapping configuration​

This is the default mapping configuration for this integration:

Default mapping configuration (Click to expand)
createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
- kind: statuspage
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .id
        title: .name
        blueprint: '"statuspage"'
        properties:
          page_description: .page_description
          headline: .headline
          branding: .branding
          status_indicator: .status_indicator
          status_description: .status_description
          subdomain: .subdomain
          domain: .domain
          url: .url
          allow_page_subscribers: .allow_page_subscribers
          allow_incident_subscribers: .allow_incident_subscribers
          allow_email_subscribers: .allow_email_subscribers
          allow_sms_subscribers: .allow_sms_subscribers
          allow_rss_atom_feeds: .allow_rss_atom_feeds
          allow_webhook_subscribers: .allow_webhook_subscribers
          time_zone: .time_zone
          createdAt: .created_at
          updatedAt: .updated_at
- kind: component_group
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .id
        title: .name
        blueprint: '"statuspageComponentGroup"'
        properties:
          description: .description
          position: .position
          createdAt: .created_at
          updatedAt: .updated_at
        relations:
          statuspage: .page_id
- kind: component
  selector:
    query: .group == false
  port:
    entity:
      mappings:
        identifier: .id
        title: .name
        blueprint: '"statuspageComponent"'
        properties:
          description: .description
          position: .position
          status: .status
          showcase: .showcase
          only_show_if_degraded: .only_show_if_degraded
          startDate: .start_date | if . == null then null else (strptime("%Y-%m-%d") | todateiso8601) end
          createdAt: .created_at
          updatedAt: .updated_at
        relations:
          componentGroup: .group_id
          statuspage: .page_id
- kind: incident
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .id
        title: .name
        blueprint: '"statuspageIncident"'
        properties:
          status: .status
          impact: .impact
          createdAt: .created_at
          updatedAt: .updated_at
          startedAt: .started_at
          resolvedAt: .resolved_at
          shortlink: .shortlink
          scheduled_for: .scheduled_for
          scheduled_until: .scheduled_until
          scheduled_remind_prior: .scheduled_remind_prior
          scheduled_reminded_at: .scheduled_reminded_at
          impact_override: .impact_override
          scheduled_auto_in_progress: .scheduled_auto_in_progress
          scheduled_auto_completed: .scheduled_auto_completed
          metadata: .metadata
          reminder_intervals: .reminder_intervals
          postmortem_body: .postmortem_body
          postmortem_body_last_updated_at: .postmortem_body_last_updated_at
          postmortem_ignored: .postmortem_ignored
          postmortem_published_at: .postmortem_published_at
          postmortem_notified_subscribers: .postmortem_notified_subscribers
          postmortem_notified_twitter: .postmortem_notified_twitter
        relations:
          components: '[.components[].id]'
          statuspage: .page_id
- kind: incident_update
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .id
        title: .body
        blueprint: '"statuspageIncidentUpdate"'
        properties:
          status: .status
          body: .body
          createdAt: .created_at
          displayAt: .display_at
          deliverNotifications: .deliver_notifications
          wantsTwitterUpdate: .wants_twitter_update
          tweet_id: .tweet_id
          custom_tweet: .custom_tweet
        relations:
          incident: .incident_id
          affectedComponents: '[.affected_components[].code]'

Monitoring and sync status​

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.

Examples​

To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground.

Examples of blueprints and the relevant integration configurations can be found on the statuspage examples page

Let's Test It​

This section includes a sample response data from Statuspage. In addition, it includes the entity created from the resync event based on the Ocean configuration provided in the previous section.

Payload​

Here is an example of the payload structure from Statuspage:

Page response data (Click to expand)
{
    "id": "8m2l51279rpl",
    "created_at": "2024-06-07T01:12:00Z",
    "updated_at": "2024-06-26T03:49:25Z",
    "name": "Ctrlv Solutions",
    "page_description": null,
    "headline": null,
    "branding": "basic",
    "subdomain": "ctrlvsolutions",
    "domain": null,
    "url": null,
    "support_url": null,
    "hidden_from_search": false,
    "allow_page_subscribers": true,
    "allow_incident_subscribers": true,
    "allow_email_subscribers": true,
    "allow_sms_subscribers": true,
    "allow_rss_atom_feeds": true,
    "allow_webhook_subscribers": false,
    "notifications_from_email": null,
    "notifications_email_footer": "You received this email because you are subscribed to Ctrlv Solutions's service status notifications.",
    "activity_score": 499,
    "twitter_username": null,
    "viewers_must_be_team_members": false,
    "ip_restrictions": null,
    "city": null,
    "state": null,
    "country": null,
    "time_zone": "UTC",
    "css_body_background_color": "ffffff",
    "css_font_color": "333333",
    "css_light_font_color": "757575",
    "css_greens": "1e8542",
    "css_yellows": "f1c40f",
    "css_oranges": "b35e14",
    "css_blues": "207ab6",
    "css_reds": "de2f1b",
    "css_border_color": "E0E0E0",
    "css_graph_color": "3498db",
    "css_link_color": "207ab6",
    "css_no_data": "b3bac5",
    "favicon_logo": {
        "updated_at": null,
        "size": null,
        "url": ""
    },
    "transactional_logo": {
        "updated_at": null,
        "original_url": "",
        "size": null,
        "normal_url": "",
        "retina_url": ""
    },
    "hero_cover": {
        "updated_at": null,
        "original_url": "",
        "size": null,
        "normal_url": "",
        "retina_url": ""
    },
    "email_logo": {
        "updated_at": null,
        "original_url": "",
        "size": null,
        "normal_url": "",
        "retina_url": ""
    },
    "twitter_logo": {
        "updated_at": null,
        "size": null,
        "url": ""
    }
}

Component Group response data (Click to expand)
{
    "id": "9w477s340zqt",
    "page_id": "8m2l51279rpl",
    "name": "Backend",
    "description": null,
    "components": [
        "3chbmx8qmlny"
    ],
    "position": 7,
    "created_at": "2024-06-06T15:51:24Z",
    "updated_at": "2024-06-06T15:51:24Z"
}
Component response data (Click to expand)
{
  "id": "y6ssccsqgy8s",
  "page_id": "8m2l51279rpl",
  "group_id": null,
  "created_at": "2024-06-07T01:12:00Z",
  "updated_at": "2024-06-07T01:12:00Z",
  "group": false,
  "name": "API Gateway",
  "description": null,
  "position": 1,
  "status": "operational",
  "showcase": true,
  "only_show_if_degraded": false,
  "automation_email": "component+4912b1b6b16b44f7be966d1389ca7dd1@notifications.statuspage.io",
  "start_date": "2024-06-07"
}
Incident response data (Click to expand)
{
  "id": "f5v3b6dr7k53",
  "components": [
    {
      "id": "7ddtptqkb02y",
      "page_id": "8m2l51279rpl",
      "group_id": null,
      "created_at": "2024-06-06T15:47:06Z",
      "updated_at": "2024-06-06T15:47:06Z",
      "group": false,
      "name": "API Gateway",
      "description": null,
      "position": 1,
      "status": "operational",
      "showcase": true,
      "only_show_if_degraded": false,
      "automation_email": "component+249149b3d4f94d599179e9a5a2f9762d@notifications.statuspage.io",
      "start_date": "2024-06-06"
    },
    {
      "id": "3chbmx8qmlny",
      "page_id": "8m2l51279rpl",
      "group_id": "9w477s340zqt",
      "created_at": "2024-06-06T15:51:24Z",
      "updated_at": "2024-06-06T15:51:24Z",
      "group": false,
      "name": "Fraud Detection Service",
      "description": null,
      "position": 1,
      "status": "operational",
      "showcase": true,
      "only_show_if_degraded": false,
      "automation_email": "component+3224d887fad941c8a39a87c6a67efcc4@notifications.statuspage.io",
      "start_date": "2024-06-06"
    },
    {
      "id": "kvpxtsp2k1lf",
      "page_id": "8m2l51279rpl",
      "group_id": null,
      "created_at": "2024-06-06T15:49:37Z",
      "updated_at": "2024-06-07T01:04:38Z",
      "group": false,
      "name": "Payment Service",
      "description": null,
      "position": 5,
      "status": "partial_outage",
      "showcase": true,
      "only_show_if_degraded": false,
      "automation_email": "component+e9ed656c064e4d15935fc611dd4c04db@notifications.statuspage.io",
      "start_date": "2024-06-06"
    },
    {
      "id": "3h6c0mc56qdr",
      "page_id": "8m2l51279rpl",
      "group_id": null,
      "created_at": "2024-06-06T15:52:14Z",
      "updated_at": "2024-06-06T15:52:14Z",
      "group": false,
      "name": "Jira Administration",
      "description": null,
      "position": 8,
      "status": "operational",
      "showcase": false,
      "only_show_if_degraded": false,
      "automation_email": "component+3cf3309f51f14f3aa7b024cf4982edda@notifications.statuspage.io",
      "start_date": null
    }
  ],
  "created_at": "2024-06-07T01:00:17Z",
  "impact": "major",
  "impact_override": "major",
  "incident_updates": [
    {
      "id": "rgm45b89jz31",
      "incident_id": "f5v3b6dr7k53",
      "affected_components": [
        {
            "code": "7ddtptqkb02y",
            "name": "API Gateway",
            "old_status": "operational",
            "new_status": "operational"
        },
        {
            "code": "kvpxtsp2k1lf",
            "name": "Payment Service",
            "old_status": "partial_outage",
            "new_status": "partial_outage"
        },
        {
            "code": "3chbmx8qmlny",
            "name": "Backend - Fraud Detection Service",
            "old_status": "operational",
            "new_status": "operational"
        },
        {
            "code": "3h6c0mc56qdr",
            "name": "Jira Administration",
            "old_status": "operational",
            "new_status": "operational"
        }
      ],
      "body": "Resolved",
      "created_at": "2024-06-07T22:26:34.370Z",
      "custom_tweet": null,
      "deliver_notifications": true,
      "display_at": "2024-06-07T22:26:34.370Z",
      "status": "resolved",
      "tweet_id": null,
      "twitter_updated_at": null,
      "updated_at": "2024-06-07T22:26:34.370Z",
      "wants_twitter_update": false
    },
    {
      "id": "p19ll31ysh49",
      "incident_id": "f5v3b6dr7k53",
      "affected_components": [
        {
            "code": "7ddtptqkb02y",
            "name": "API Gateway",
            "old_status": "operational",
            "new_status": "operational"
        },
        {
            "code": "kvpxtsp2k1lf",
            "name": "Payment Service",
            "old_status": "partial_outage",
            "new_status": "partial_outage"
        },
        {
            "code": "3chbmx8qmlny",
            "name": "Backend - Fraud Detection Service",
            "old_status": "operational",
            "new_status": "operational"
        }
      ],
      "body": "checking components",
      "created_at": "2024-06-07T22:22:28.761Z",
      "custom_tweet": null,
      "deliver_notifications": true,
      "display_at": "2024-06-07T22:22:28.761Z",
      "status": "monitoring",
      "tweet_id": null,
      "twitter_updated_at": null,
      "updated_at": "2024-06-07T22:22:28.761Z",
      "wants_twitter_update": false
    },
    {
      "id": "gkjdpm52nm97",
      "incident_id": "f5v3b6dr7k53",
      "affected_components": null,
      "body": "We are currently experiencing timeout errors with our API Gateway. Some API requests may fail or take longer to process. Our team is investigating the issue.",
      "created_at": "2024-06-07T01:00:17.309Z",
      "custom_tweet": null,
      "deliver_notifications": true,
      "display_at": "2024-06-07T01:00:17.309Z",
      "status": "investigating",
      "tweet_id": null,
      "twitter_updated_at": null,
      "updated_at": "2024-06-07T01:00:17.309Z",
      "wants_twitter_update": false
    }
  ],
  "metadata": {
      "port": {
          "runId": "r_hUFsDXiY5DzF3sjf",
          "trigger": "Object"
      }
  },
  "monitoring_at": "2024-06-07T22:22:28Z",
  "name": "API Gateway Timeout Errors",
  "page_id": "8m2l51279rpl",
  "postmortem_body": null,
  "postmortem_body_last_updated_at": null,
  "postmortem_ignored": false,
  "postmortem_notified_subscribers": false,
  "postmortem_notified_twitter": false,
  "postmortem_published_at": null,
  "resolved_at": "2024-06-07T22:26:34Z",
  "scheduled_auto_completed": false,
  "scheduled_auto_in_progress": false,
  "scheduled_for": null,
  "auto_transition_deliver_notifications_at_end": null,
  "auto_transition_deliver_notifications_at_start": null,
  "auto_transition_to_maintenance_state": null,
  "auto_transition_to_operational_state": null,
  "scheduled_remind_prior": false,
  "scheduled_reminded_at": null,
  "scheduled_until": null,
  "shortlink": "https://stspg.io/t4szpmm54wxx",
  "status": "resolved",
  "updated_at": "2024-06-07T22:26:34Z",
  "reminder_intervals": null
}
Incident Update response data (Click to expand)
{
  "id": "gkjdpm52nm97",
  "incident_id": "f5v3b6dr7k53",
  "affected_components": null,
  "body": "We are currently experiencing timeout errors with our API Gateway. Some API requests may fail or take longer to process. Our team is investigating the issue.",
  "created_at": "2024-06-07T01:00:17.309Z",
  "custom_tweet": null,
  "deliver_notifications": true,
  "display_at": "2024-06-07T01:00:17.309Z",
  "status": "investigating",
  "tweet_id": null,
  "twitter_updated_at": null,
  "updated_at": "2024-06-07T01:00:17.309Z",
  "wants_twitter_update": false
}

Mapping Result​

The combination of the sample payload and the Ocean configuration generates the following Port entity:

Page entity in Port (Click to expand)
{
  "identifier": "8m2l51279rpl",
  "title": "Ctrlv Solutions",
  "blueprint": "statuspage",
  "icon": "StatusPage",
  "team": [],
  "properties": {
    "time_zone": "UTC",
    "updatedAt": "2024-06-21T01:31:52Z",
    "allow_sms_subscribers": true,
    "allow_webhook_subscribers": false,
    "allow_page_subscribers": true,
    "allow_rss_atom_feeds": true,
    "branding": "basic",
    "allow_incident_subscribers": true,
    "subdomain": "ctrlvsolutions",
    "createdAt": "2024-06-07T01:12:00Z",
    "allow_email_subscribers": true
  },
  "relations": {},
  "createdAt": "2024-06-25T07:59:28.716Z",
  "createdBy": "<port-client-id>",
  "updatedAt": "2024-06-25T07:59:28.716Z",
  "updatedBy": "<port-client-id>"
}
Component Group entity in Port (Click to expand)
{
  "identifier": "9w477s340zqt",
  "title": "Backend",
  "blueprint": "statuspageComponentGroup",
  "icon": "StatusPage",
  "team": [],
  "properties": {
    "updatedAt": "2024-06-06T15:51:24Z",
    "position": 7,
    "createdAt": "2024-06-06T15:51:24Z"
  },
  "relations": {
    "statuspage": "8m2l51279rpl"
  },
  "createdAt": "2024-06-25T07:59:33.363Z",
  "createdBy": "<port-client-id>",
  "updatedAt": "2024-06-25T07:59:33.363Z",
  "updatedBy": "<port-client-id>"
}
Component entity in Port (Click to expand)
{
  "identifier": "y6ssccsqgy8s",
  "title": "API Gateway",
  "blueprint": "statuspageComponent",
  "icon": "StatusPage",
  "team": [],
  "properties": {
    "startDate": "2024-06-07T00:00:00Z",
    "only_show_if_degraded": false,
    "status": "operational",
    "updatedAt": "2024-06-07T01:12:00Z",
    "position": 1,
    "showcase": true,
    "createdAt": "2024-06-07T01:12:00Z"
  },
  "relations": {
    "statuspage": "8m2l51279rpl",
    "componentGroup": null
  },
  "createdAt": "2024-06-25T07:59:35.830Z",
  "createdBy": "<port-client-id>",
  "updatedAt": "2024-06-25T07:59:35.830Z",
  "updatedBy": "<port-client-id>"
}
Incident entity in Port (Click to respond)
{
  "identifier": "f5v3b6dr7k53",
  "title": "API Gateway Timeout Errors",
  "blueprint": "statuspageIncident",
  "icon": "StatusPage",
  "team": [],
  "properties": {
    "scheduled_auto_completed": false,
    "createdAt": "2024-06-07T01:00:17.239Z",
    "metadata": {
      "port": {
        "runId": "r_hUFsDXiY5DzF3sjf",
        "trigger": "Object"
      }
    },
    "impact": "major",
    "updatedAt": "2024-06-07T22:26:34.383Z",
    "status": "resolved",
    "shortlink": "https://stspg.io/t4szpmm54wxx",
    "postmortem_ignored": false,
    "startedAt": "2024-06-07T01:00:17.228Z",
    "scheduled_auto_in_progress": false,
    "postmortem_notified_subscribers": false,
    "scheduled_remind_prior": false,
    "resolvedAt": "2024-06-07T22:26:34.370Z",
    "postmortem_notified_twitter": false,
    "category": "incident"
  },
  "relations": {
    "components": [
      "7ddtptqkb02y",
      "3chbmx8qmlny",
      "kvpxtsp2k1lf",
      "3h6c0mc56qdr"
    ],
    "statuspage": "8m2l51279rpl"
  },
  "createdAt": "2024-06-25T08:00:39.222Z",
  "createdBy": "<port-client-id>",
  "updatedAt": "2024-06-25T08:00:39.222Z",
  "updatedBy": "<port-client-id>"
}
Incident Update entity in Port (Click to expand)t
{
  "identifier": "gkjdpm52nm97",
  "title": "We are currently experiencing timeout errors with our API Gateway. Some API requests may fail or take longer to process. Our team is investigating the issue.",
  "blueprint": "statuspageIncidentUpdate",
  "icon": "StatusPage",
  "team": [],
  "properties": {
    "status": "investigating",
    "wantsTwitterUpdate": false,
    "body": "We are currently experiencing timeout errors with our API Gateway. Some API requests may fail or take longer to process. Our team is investigating the issue.",
    "deliverNotifications": true,
    "createdAt": "2024-06-07T01:00:17.309Z",
    "displayAt": "2024-06-07T01:00:17.309Z",
    "category": "incident"
  },
  "relations": {
    "incident": "f5v3b6dr7k53",
    "affectedComponents": []
  },
  "createdAt": "2024-06-25T08:00:46.083Z",
  "createdBy": "<port-client-id>",
  "updatedAt": "2024-06-25T08:00:46.083Z",
  "updatedBy": "<port-client-id>"
}