PagerDuty

Our PagerDuty integration allows you to import schedules, oncalls, services and incidents from your PagerDuty account into Port, according to your mapping and definitions.

Common use cases

• Map schedules, oncalls, services and incidents in your PagerDuty organization environment.
• Watch for object changes (create/update/delete) in real-time, and automatically apply the changes to your entities in Port.

Prerequisites

To install the integration, you need a Kubernetes cluster that the integration's container chart will be deployed to.

Please make sure that you have kubectl and helm installed on your machine, and that your kubectl CLI is connected to the Kubernetes cluster where you plan to install the integration.

Troubleshooting

If you are having trouble installing this integration, please refer to these troubleshooting steps.

Installation

Choose one of the following installation methods:

Real Time & Always On

Using this installation option means that the integration will be able to update Port in real time using webhooks.

This table summarizes the available parameters for the installation. Set them as you wish in the script below, then copy it and run it in your terminal:

Parameter	Description	Required
port.clientId	Your port client id	✅
port.clientSecret	Your port client secret	✅
port.baseUrl	Your port base url, relevant only if not using the default port app	❌
integration.identifier	Change the identifier to describe your integration	✅
integration.type	The integration type	✅
integration.eventListener.type	The event listener type	✅
integration.secrets.token	PagerDuty API token	✅
integration.config.apiUrl	Pagerduty api url. If not specified, the default will be https://api.pagerduty.com	✅
integration.config.appHost	The host of the Port Ocean app. Used to set up the integration endpoint as the target for Webhooks created in PagerDuty	❌
scheduledResyncInterval	The number of minutes between each resync	❌
initializePortResources	Default true, When set to true the integration will create default blueprints and the port App config Mapping	❌

Helm

To install the integration using Helm, run the following command:

helm repo add --force-update port-labs https://port-labs.github.io/helm-charts
helm upgrade --install my-pagerduty-integration port-labs/port-ocean \
  --set port.clientId="PORT_CLIENT_ID"  \
  --set port.clientSecret="PORT_CLIENT_SECRET"  \
  --set port.baseUrl="https://api.getport.io"  \
  --set initializePortResources=true  \
  --set scheduledResyncInterval=120  \
  --set integration.identifier="my-pagerduty-integration"  \
  --set integration.type="pagerduty"  \
  --set integration.eventListener.type="POLLING"  \
  --set integration.secrets.token="string"  \
  --set integration.config.apiUrl="string"

ArgoCD

To install the integration using ArgoCD, follow these steps:

1. Create a values.yaml file in argocd/my-ocean-pagerduty-integration in your git repository with the content:

note

Remember to replace the placeholders for PAGERDUTY_API_URL and PAGERDUTY_API_TOKEN.

initializePortResources: true
scheduledResyncInterval: 120
integration:
  identifier: my-ocean-pagerduty-integration
  type: pagerduty
  eventListener:
    type: POLLING
  config:
    apiUrl: PAGERDUTY_API_URL
  secrets:
    token: PAGERDUTY_API_TOKEN

2. Install the my-ocean-pagerduty-integration ArgoCD Application by creating the following my-ocean-pagerduty-integration.yaml manifest:

note

Remember to replace the placeholders for YOUR_PORT_CLIENT_ID YOUR_PORT_CLIENT_SECRET and YOUR_GIT_REPO_URL.

Multiple sources ArgoCD documentation can be found here.

ArgoCD Application

apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: my-ocean-pagerduty-integration
  namespace: argocd
spec:
  destination:
    namespace: my-ocean-pagerduty-integration
    server: https://kubernetes.default.svc
  project: default
  sources:
  - repoURL: 'https://port-labs.github.io/helm-charts/'
    chart: port-ocean
    targetRevision: 0.1.14
    helm:
      valueFiles:
      - $values/argocd/my-ocean-pagerduty-integration/values.yaml
      parameters:
        - name: port.clientId
          value: YOUR_PORT_CLIENT_ID
        - name: port.clientSecret
          value: YOUR_PORT_CLIENT_SECRET
  - repoURL: YOUR_GIT_REPO_URL
    targetRevision: main
    ref: values
  syncPolicy:
    automated:
      prune: true
      selfHeal: true
    syncOptions:
    - CreateNamespace=true

3. Apply your application manifest with kubectl:

kubectl apply -f my-ocean-pagerduty-integration.yaml

Scheduled

GitHub

This workflow will run the PagerDuty integration once and then exit, this is useful for scheduled ingestion of data.

warning

If you want the integration to update Port in real time using webhooks you should use the Real Time & Always On installation option

Make sure to configure the following Github Secrets:

Parameter	Description	Required
OCEAN__INTEGRATION__CONFIG__TOKEN	The PagerDuty token	✅
OCEAN__INTEGRATION__CONFIG__API_URL	The PagerDuty API URL	✅
OCEAN__INITIALIZE_PORT_RESOURCES	Default true, When set to false the integration will not create default blueprints and the port App config Mapping	❌
OCEAN__INTEGRATION__IDENTIFIER	Change the identifier to describe your integration, if not set will use the default one	❌
OCEAN__PORT__CLIENT_ID	Your port client id	✅
OCEAN__PORT__CLIENT_SECRET	Your port client secret	✅
OCEAN__PORT__BASE_URL	Your port base url, relevant only if not using the default port app	❌

Here is an example for pagerduty-integration.yml workflow file:

name: PagerDuty Exporter Workflow

# This workflow responsible for running PagerDuty exporter.

on:
  workflow_dispatch:

jobs:
  run-integration:
    runs-on: ubuntu-latest

    steps:
      - uses: port-labs/ocean-sail@v1
        with:
          type: 'pagerduty'
          port_client_id: ${{ secrets.OCEAN__PORT__CLIENT_ID }}
          port_client_secret: ${{ secrets.OCEAN__PORT__CLIENT_SECRET }}
          config: |
            token: ${{ secrets.OCEAN__INTEGRATION__CONFIG__TOKEN }} 
            api_url: ${{ secrets.OCEAN__INTEGRATION__CONFIG__API_URL }} 

Jenkins

This pipeline will run the PagerDuty integration once and then exit, this is useful for scheduled ingestion of data.

tip

Your Jenkins agent should be able to run docker commands.

warning

If you want the integration to update Port in real time using webhooks you should use the Real Time & Always On installation option.

Make sure to configure the following Jenkins Credentials of Secret Text type:

Parameter	Description	Required
OCEAN__INTEGRATION__CONFIG__TOKEN	The PagerDuty token	✅
OCEAN__INTEGRATION__CONFIG__API_URL	The PagerDuty API URL	✅
OCEAN__INITIALIZE_PORT_RESOURCES	Default true, When set to false the integration will not create default blueprints and the port App config Mapping	❌
OCEAN__INTEGRATION__IDENTIFIER	Change the identifier to describe your integration, if not set will use the default one	❌
OCEAN__PORT__CLIENT_ID	Your port client id	✅
OCEAN__PORT__CLIENT_SECRET	Your port client secret	✅
OCEAN__PORT__BASE_URL	Your port base url, relevant only if not using the default port app	❌

Here is an example for Jenkinsfile groovy pipeline file:

pipeline {
    agent any

    stages {
        stage('Run PagerDuty Integration') {
            steps {
                script {
                    withCredentials([
                        string(credentialsId: 'OCEAN__INTEGRATION__CONFIG__TOKEN', variable: 'OCEAN__INTEGRATION__CONFIG__TOKEN'),
                        string(credentialsId: 'OCEAN__INTEGRATION__CONFIG__API_URL', variable: 'OCEAN__INTEGRATION__CONFIG__API_URL'),
                        string(credentialsId: 'OCEAN__PORT__CLIENT_ID', variable: 'OCEAN__PORT__CLIENT_ID'),
                        string(credentialsId: 'OCEAN__PORT__CLIENT_SECRET', variable: 'OCEAN__PORT__CLIENT_SECRET'),
                    ]) {
                        sh('''
                            #Set Docker image and run the container
                            integration_type="pagerduty"
                            version="latest"
                            image_name="ghcr.io/port-labs/port-ocean-${integration_type}:${version}"
                            docker run -i --rm --platform=linux/amd64 \
                                -e OCEAN__EVENT_LISTENER='{"type":"ONCE"}' \
                                -e OCEAN__INITIALIZE_PORT_RESOURCES=true \
                                -e OCEAN__INTEGRATION__CONFIG__TOKEN=$OCEAN__INTEGRATION__CONFIG__TOKEN \
                                -e OCEAN__INTEGRATION__CONFIG__API_URL=$OCEAN__INTEGRATION__CONFIG__API_URL \
                                -e OCEAN__PORT__CLIENT_ID=$OCEAN__PORT__CLIENT_ID \
                                -e OCEAN__PORT__CLIENT_SECRET=$OCEAN__PORT__CLIENT_SECRET \
                                $image_name

                            exit $?
                        ''')
                    }
                }
            }
        }
    }
}

Azure Devops

This pipeline will run the PagerDuty integration once and then exit, this is useful for scheduled ingestion of data.

tip

Your Azure Devops agent should be able to run docker commands. Learn more about agents here.

warning

If you want the integration to update Port in real time using webhooks you should use the Real Time & Always On installation option.

Configure the variables in a variable group

Variable groups store values and secrets you'll use in your pipelines across your project. Learn more

Setting Up Your Credentials

1. Create a Variable Group: Name it port-ocean-credentials. Store the required variables from the table.
2. Authorize Your Pipeline:
   • Go to "Library" -> "Variable groups."
   • Find port-ocean-credentials and click on it.
   • Select "Pipeline Permissions" and add your pipeline to the authorized list.

Parameter	Description	Required
OCEAN__INTEGRATION__CONFIG__TOKEN	The PagerDuty token	✅
OCEAN__INTEGRATION__CONFIG__API_URL	The PagerDuty API URL	✅
OCEAN__INITIALIZE_PORT_RESOURCES	Default true, When set to false the integration will not create default blueprints and the port App config Mapping	❌
OCEAN__INTEGRATION__IDENTIFIER	Change the identifier to describe your integration, if not set will use the default one	❌
OCEAN__PORT__CLIENT_ID	Your port client id	✅
OCEAN__PORT__CLIENT_SECRET	Your port client secret	✅
OCEAN__PORT__BASE_URL	Your port base url, relevant only if not using the default port app	❌

Here is an example for pagerduty-integration.yml pipeline file:

trigger:
- main

pool:
  vmImage: "ubuntu-latest"

variables:
  - group: port-ocean-credentials


steps:
- script: |
    # Set Docker image and run the container
    integration_type="pagerduty"
    version="latest"

    image_name="ghcr.io/port-labs/port-ocean-$integration_type:$version"
    
    docker run -i --rm --platform=linux/amd64 \
        -e OCEAN__EVENT_LISTENER='{"type":"ONCE"}' \
        -e OCEAN__INITIALIZE_PORT_RESOURCES=true \
        -e OCEAN__INTEGRATION__CONFIG__TOKEN=$(OCEAN__INTEGRATION__CONFIG__TOKEN) \
        -e OCEAN__INTEGRATION__CONFIG__API_URL=$(OCEAN__INTEGRATION__CONFIG__API_URL) \
        -e OCEAN__PORT__CLIENT_ID=$(OCEAN__PORT__CLIENT_ID) \
        -e OCEAN__PORT__CLIENT_SECRET=$(OCEAN__PORT__CLIENT_SECRET) \
        $image_name

    exit $?
  displayName: 'Ingest Data into Port'

Advanced integration configuration

For advanced configuration such as proxies or self-signed certificates, click here.

Ingesting PagerDuty objects

The PagerDuty integration uses a YAML configuration to describe the process of loading data into the developer portal. See examples below.

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

Configuration structure

The integration configuration determines which resources will be queried from PagerDuty, and which entities and properties will be created in Port.

Supported resources

The following resources can be used to map data from PagerDuty, it is possible to reference any field that appears in the API responses linked below for the mapping configuration.

• Schedule
• Oncall
• Service
• Incident

• The root key of the integration configuration is the resources key:

  resources:
    - kind: services
      selector:
      ...

• The kind key is a specifier for a PagerDuty object:

    resources:
      - kind: services
        selector:
        ...

• The selector and the query keys allow you to filter which objects of the specified kind will be ingested into your software catalog:

  resources:
    - kind: services
      selector:
        query: "true" # JQ boolean expression. If evaluated to false - this object will be skipped.
      port:

• The port, entity and the mappings keys are used to map the PagerDuty object fields to Port entities. To create multiple mappings of the same kind, you can add another item in the resources array;

  resources:
    - kind: services
      selector:
        query: "true"
      port:
        entity:
          mappings: # Mappings between one PagerDuty object to a Port entity. Each value is a JQ query.
            identifier: .id
            title: .name
            blueprint: '"pagerdutyService"'
            properties:
              status: .status
    - kind: service # In this instance service is mapped again with a different filter
      selector:
        query: '.name == "MyProjectName"'
      port:
        entity:
          mappings: ...
  Blueprint key

  Note the value of the blueprint key - if you want to use a hardcoded string, you need to encapsulate it in 2 sets of quotes, for example use a pair of single-quotes (') and then another pair of double-quotes (")

Ingest data into Port

To ingest PagerDuty objects using the integration configuration, you can follow the steps below:

1. Go to the DevPortal Builder page.
2. Select a blueprint you want to ingest using PagerDuty.
3. Choose the Ingest Data option from the menu.
4. Select PagerDuty under the Incident management category.
5. Modify the configuration according to your needs.
6. Click Resync.

Examples

Examples of blueprints and the relevant integration configurations:

Schedule

Schedule blueprint

{
  "identifier": "pagerdutySchedule",
  "description": "This blueprint represents a PagerDuty schedule in our software catalog",
  "title": "PagerDuty Schedule",
  "icon": "pagerduty",
  "schema": {
    "properties": {
      "url": {
        "title": "Schedule URL",
        "type": "string",
        "format": "url"
      },
      "timezone": {
        "title": "Timezone",
        "type": "string"
      },
      "description": {
        "title": "Description",
        "type": "string"
      },
      "users": {
        "title": "Users",
        "type": "array"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "aggregationProperties": {},
  "relations": {}
}

Integration configuration

createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: schedules
    selector:
      query: "true"
    port:
      entity:
        mappings:
          identifier: .id
          title: .name
          blueprint: '"pagerdutySchedule"'
          properties:
            url: .html_url
            timezone: .time_zone
            description: .description
            users: "[.users[].summary]"

Oncall

Oncall blueprint

{
  "identifier": "pagerdutyOncall",
  "description": "This blueprint represents a PagerDuty oncall schedule in our software catalog",
  "title": "PagerDuty Oncall Schedule",
  "icon": "pagerduty",
  "schema": {
    "properties": {
      "url": {
        "title": "Oncall Schedule URL",
        "type": "string",
        "format": "url"
      },
      "user": {
        "title": "User",
        "type": "string",
        "format": "user"
      },
      "startDate": {
        "title": "Start Date",
        "type": "string",
        "format": "date-time"
      },
      "endDate": {
        "title": "End Date",
        "type": "string",
        "format": "date-time"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "aggregationProperties": {},
  "relations": {
    "pagerdutySchedule": {
      "title": "PagerDuty Schedule",
      "target": "pagerdutySchedule",
      "required": false,
      "many": true
    }
  }
}

Integration configuration

createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: oncalls
    selector:
      query: 'true'
      apiQueryParams:
        include: ['users']
    port:
      entity:
        mappings:
          identifier: .user.id + "-" + .schedule.id + "-" + .start
          title: .user.name
          blueprint: '"pagerdutyOncall"'
          properties:
            user: .user.email
            startDate: .start
            endDate: .end
            url: .schedule.html_url
          relations:
            pagerdutySchedule: .schedule.id

Service

Service blueprint

{
  "identifier": "pagerdutyService",
  "description": "This blueprint represents a PagerDuty service in our software catalog",
  "title": "PagerDuty Service",
  "icon": "pagerduty",
  "schema": {
    "properties": {
      "status": {
        "title": "Status",
        "type": "string",
        "enum": [
          "active",
          "warning",
          "critical",
          "maintenance",
          "disabled"
        ],
        "enumColors": {
          "active": "green",
          "warning": "yellow",
          "critical": "red",
          "maintenance": "lightGray",
          "disabled": "darkGray"
        }
      },
      "url": {
        "title": "URL",
        "type": "string",
        "format": "url"
      },
      "oncall": {
        "title": "On Call",
        "type": "string",
        "format": "user"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {}
}

Integration configuration

createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: services
    selector:
      query: "true"
    port:
      entity:
        mappings:
          identifier: .id
          title: .name
          blueprint: '"pagerdutyService"'
          properties:
            status: .status
            url: .html_url
            oncall: .__oncall_user[] | select(.escalation_level == 1) | .user.email

Incident

Incident blueprint

{
  "identifier": "pagerdutyIncident",
  "description": "This blueprint represents a PagerDuty incident in our software catalog",
  "title": "PagerDuty Incident",
  "icon": "pagerduty",
  "schema": {
    "properties": {
      "status": {
        "type": "string",
        "title": "Incident Status",
        "enum": [
          "triggered",
          "annotated",
          "acknowledged",
          "reassigned",
          "escalated",
          "reopened",
          "resolved"
        ]
      },
      "url": {
        "type": "string",
        "format": "url",
        "title": "Incident URL"
      },
      "urgency": {
        "type": "string",
        "title": "Incident Urgency",
        "enum": ["high", "low"]
      },
      "responder": {
        "type": "string",
        "title": "Assignee"
      },
      "escalation_policy": {
        "type": "string",
        "title": "Escalation Policy"
      },
      "created_at": {
        "title": "Create At",
        "type": "string",
        "format": "date-time"
      },
      "updated_at": {
        "title": "Updated At",
        "type": "string",
        "format": "date-time"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {
    "pagerdutyService": {
      "title": "PagerDuty Service",
      "target": "pagerdutyService",
      "required": false,
      "many": true
    }
  }
}

Integration configuration

createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: incidents
    selector:
      query: "true"
    port:
      entity:
        mappings:
          identifier: .id | tostring
          title: .title
          blueprint: '"pagerdutyIncident"'
          properties:
            status: .status
            url: .self
            urgency: .urgency
            responder: .assignments[0].assignee.summary
            escalation_policy: .escalation_policy.summary
            created_at: .created_at
            updated_at: .updated_at
          relations:
            pagerdutyService: .service.id

Ingesting service analytics

To enrich your PagerDuty service entities with analytics data, follow the steps below:

1. Update the service blueprint to include analytics properties. You can add any property that is returned from the PagerDuty aggregated service analytics API

   Updated service blueprint

   {
     "identifier":"pagerdutyService",
     "description":"This blueprint represents a PagerDuty service in our software catalog",
     "title":"PagerDuty Service",
     "icon":"pagerduty",
     "schema":{
         "properties":{
           "status":{
               "title":"Status",
               "type":"string"
           },
           "url":{
               "title":"URL",
               "type":"string",
               "format":"url"
           },
           "oncall":{
               "title":"On Call",
               "type":"array",
               "items":{
                 "type":"string",
                 "format":"user"
               }
           },
           "meanSecondsToResolve":{
               "title":"Mean Seconds to Resolve",
               "type":"number"
           },
           "meanSecondsToFirstAck":{
               "title":"Mean Seconds to First Acknowledge",
               "type":"number"
           },
           "meanSecondsToEngage":{
               "title":"Mean Seconds to Engage",
               "type":"number"
           },
           "totalIncidentCount":{
               "title":"Total Incident Count",
               "type":"number"
           },
           "totalIncidentsAcknowledged":{
               "title":"Total Incidents Acknowledged",
               "type":"number"
           },
           "totalIncidentsAutoResolved":{
               "title":"Total Incidents Auto Resolved",
               "type":"number"
           },
           "totalIncidentsManualEscalated":{
               "title":"Total Incident Manual Escalated",
               "type":"number"
           }
         },
         "required":[]
     },
     "mirrorProperties":{},
     "calculationProperties":{},
     "relations":{}
   }

2. Add serviceAnalytics property to the integration selector key. When set to true, the integration will fetch data from the PagerDuty aggregated service analytics API and ingest it to Port. By default, this property is set to true.

   Also, by default, the integration aggregates the analytics over a period of 3 months. Use the analyticsMonthsPeriod filter to override this date range. The accepted values are positive number between 1 to 12. In the provided example below, we aggregate the analytics over the past 6 months.

   resources:
     - kind: services
       selector:
         query: "true"
         serviceAnalytics: "true"
         analyticsMonthsPeriod: 6
       port:
         entity:
           mappings:
             identifier: .id
             title: .name
             blueprint: '"pagerdutyService"'
             properties:
               status: .status
               url: .html_url
               oncall: "[.__oncall_user[].user.email]"

3. Establish a mapping between the analytics properties and the service analytics data response. Following a convention, the aggregated result of the PagerDuty service analytics API is saved to the __analytics key and merged with the response of the service API. Consequently, users can access specific metrics such as the mean seconds to resolve by referencing __analytics.mean_seconds_to_resolve.

   resources:
     - kind: services
       selector:
         query: "true"
         serviceAnalytics: "true"
         analyticsMonthsPeriod: 6
       port:
         entity:
           mappings:
             identifier: .id
             title: .name
             blueprint: '"pagerdutyService"'
             properties:
               status: .status
               url: .html_url
               oncall: "[.__oncall_user[].user.email]"
               meanSecondsToResolve: .__analytics.mean_seconds_to_resolve

4. Below is the complete integration configuration for enriching the service blueprint with analytics data.

   Service analytics integration configuration

   resources:
     - kind: services
       selector:
         query: "true"
         serviceAnalytics: "true"
         analyticsMonthsPeriod: 6
       port:
         entity:
           mappings:
             identifier: .id
             title: .name
             blueprint: '"pagerdutyService"'
             properties:
               status: .status
               url: .html_url
               oncall: "[.__oncall_user[].user.email]"
               meanSecondsToResolve: .__analytics.mean_seconds_to_resolve
               meanSecondsToFirstAck: .__analytics.mean_seconds_to_first_ack
               meanSecondsToEngage: .__analytics.mean_seconds_to_engage
               totalIncidentCount: .__analytics.total_incident_count
               totalIncidentsAcknowledged: .__analytics.total_incidents_acknowledged
               totalIncidentsAutoResolved: .__analytics.total_incidents_auto_resolved
               totalIncidentsManualEscalated: .__analytics.total_incidents_manual_escalated

Ingesting incident analytics

To enrich your PagerDuty incident entities with analytics data, follow the steps below:

1. Update the incident blueprint to include an analytics property.

   Updated incident blueprint

   {
     "identifier": "pagerdutyIncident",
     "description": "This blueprint represents a PagerDuty incident in our software catalog",
     "title": "PagerDuty Incident",
     "icon": "pagerduty",
     "schema": {
       "properties": {
         "status": {
           "type": "string",
           "title": "Incident Status",
           "enum": [
             "triggered",
             "annotated",
             "acknowledged",
             "reassigned",
             "escalated",
             "reopened",
             "resolved"
           ]
         },
         "url": {
           "type": "string",
           "format": "url",
           "title": "Incident URL"
         },
         "urgency": {
           "type": "string",
           "title": "Incident Urgency",
           "enum": ["high", "low"]
         },
         "responder": {
           "type": "string",
           "title": "Assignee"
         },
         "escalation_policy": {
           "type": "string",
           "title": "Escalation Policy"
         },
         "created_at": {
           "title": "Create At",
           "type": "string",
           "format": "date-time"
         },
         "updated_at": {
           "title": "Updated At",
           "type": "string",
           "format": "date-time"
         },
         "analytics": {
           "title": "Analytics",
           "type": "object"
         }
       },
       "required": []
     },
     "mirrorProperties": {},
     "calculationProperties": {},
     "relations": {
       "pagerdutyService": {
         "title": "PagerDuty Service",
         "target": "pagerdutyService",
         "required": false,
         "many": true
       }
     }
   }

2. Add incidentAnalytics property to the integration selector key. When set to true, the integration will fetch data from the PagerDuty Analytics API and ingest it to Port. By default, this property is set to false.

   resources:
     - kind: incidents
       selector:
         query: "true"
         incidentAnalytics: "true"
       port:
         entity:
           mappings:
             identifier: .id | tostring
             title: .title
             blueprint: '"pagerdutyIncident"'
             properties:
               status: .status
               url: .self

3. Establish a mapping between the analytics blueprint property and the analytics data response.

   resources:
     - kind: incidents
       selector:
         query: "true"
         incidentAnalytics: "true"
       port:
         entity:
           mappings:
             identifier: .id | tostring
             title: .title
             blueprint: '"pagerdutyIncident"'
             properties:
               status: .status
               url: .self
               urgency: .urgency
               responder: .assignments[0].assignee.summary
               escalation_policy: .escalation_policy.summary
               created_at: .created_at
               updated_at: .updated_at
               analytics: .__analytics
             relations:
               pagerdutyService: .service.id

4. Below is the complete integration configuration for enriching the incident blueprint with analytics data.

   Incident analytics integration configuration

   resources:
   - kind: incidents
     selector:
       query: "true"
       incidentAnalytics: "true"
     port:
       entity:
         mappings:
           identifier: .id | tostring
           title: .title
           blueprint: '"pagerdutyIncident"'
           properties:
             status: .status
             url: .self
             urgency: .urgency
             responder: .assignments[0].assignee.summary
             escalation_policy: .escalation_policy.summary
             created_at: .created_at
             updated_at: .updated_at
             analytics: .__analytics
           relations:
             pagerdutyService: .service.id

Let's Test It

This section includes a sample response data from Pagerduty. 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 Pagerduty:

Schedule response data

{
  "id": "PWAXLIH",
  "type": "schedule",
  "summary": "Port Test Service - Weekly Rotation",
  "self": "https://api.pagerduty.com/schedules/PWAXLIH",
  "html_url": "https://getport-io.pagerduty.com/schedules/PWAXLIH",
  "name": "Port Test Service - Weekly Rotation",
  "time_zone": "Asia/Jerusalem",
  "description": "This is the weekly on call schedule for Port Test Service associated with your first escalation policy.",
  "users": [
    {
      "id": "PJCRRLH",
      "type": "user_reference",
      "summary": "Adam",
      "self": "https://api.pagerduty.com/users/PJCRRLH",
      "html_url": "https://getport-io.pagerduty.com/users/PJCRRLH"
    },
    {
      "id": "P4K4DLP",
      "type": "user_reference",
      "summary": "Alice",
      "self": "https://api.pagerduty.com/users/P4K4DLP",
      "html_url": "https://getport-io.pagerduty.com/users/P4K4DLP"
    },
    {
      "id": "HDW63E2",
      "type": "user_reference",
      "summary": "Doe",
      "self": "https://api.pagerduty.com/users/HDW63E2",
      "html_url": "https://getport-io.pagerduty.com/users/HDW63E2"
    },
    {
      "id": "PRGAUI4",
      "type": "user_reference",
      "summary": "Pages",
      "self": null,
      "html_url": "https://getport-io.pagerduty.com/users/PRGAUI4",
      "deleted_at": "2023-10-17T18:58:07+03:00"
    },
    {
      "id": "PYIEKLY",
      "type": "user_reference",
      "summary": "Demo",
      "self": "https://api.pagerduty.com/users/PYIEKLY",
      "html_url": "https://getport-io.pagerduty.com/users/PYIEKLY"
    }
  ],
  "escalation_policies": [
    {
      "id": "P7LVMYP",
      "type": "escalation_policy_reference",
      "summary": "Test Escalation Policy",
      "self": "https://api.pagerduty.com/escalation_policies/P7LVMYP",
      "html_url": "https://getport-io.pagerduty.com/escalation_policies/P7LVMYP"
    }
  ],
  "teams": []
}

Oncall response data

{
   "escalation_policy":{
      "id":"P7LVMYP",
      "type":"escalation_policy_reference",
      "summary":"Test Escalation Policy",
      "self":"https://api.pagerduty.com/escalation_policies/P7LVMYP",
      "html_url":"https://getport-io.pagerduty.com/escalation_policies/P7LVMYP"
   },
   "escalation_level":1,
   "schedule":{
      "id":"PWAXLIH",
      "type":"schedule_reference",
      "summary":"Port Test Service - Weekly Rotation",
      "self":"https://api.pagerduty.com/schedules/PWAXLIH",
      "html_url":"https://getport-io.pagerduty.com/schedules/PWAXLIH"
   },
   "user":{
      "name":"John Doe",
      "email":"johndoe@domain.io",
      "time_zone":"Asia/Jerusalem",
      "color":"red",
      "avatar_url":"https://secure.gravatar.com/avatar/149cf38119ee25af9b8b3a68d06f39e3.png?d=mm&r=PG",
      "billed":true,
      "role":"user",
      "description":null,
      "invitation_sent":false,
      "job_title":null,
      "teams":[
         
      ],
      "contact_methods":[
         {
            "id":"PK3SHEX",
            "type":"email_contact_method_reference",
            "summary":"Default",
            "self":"https://api.pagerduty.com/users/HDW63E2/contact_methods/PK3SHEX",
            "html_url":null
         },
         {
            "id":"PO3TNV8",
            "type":"phone_contact_method_reference",
            "summary":"Other",
            "self":"https://api.pagerduty.com/users/HDW63E2/contact_methods/PO3TNV8",
            "html_url":null
         },
         {
            "id":"P7U59FI",
            "type":"sms_contact_method_reference",
            "summary":"Other",
            "self":"https://api.pagerduty.com/users/HDW63E2/contact_methods/P7U59FI",
            "html_url":null
         }
      ],
      "notification_rules":[
         {
            "id":"PMTOCX1",
            "type":"assignment_notification_rule_reference",
            "summary":"0 minutes: channel PK3SHEX",
            "self":"https://api.pagerduty.com/users/HDW63E2/notification_rules/PMTOCX1",
            "html_url":null
         },
         {
            "id":"P3HAND3",
            "type":"assignment_notification_rule_reference",
            "summary":"0 minutes: channel P7U59FI",
            "self":"https://api.pagerduty.com/users/HDW63E2/notification_rules/P3HAND3",
            "html_url":null
         }
      ],
      "id":"HDW63E2",
      "type":"user",
      "summary":"John Doe",
      "self":"https://api.pagerduty.com/users/HDW63E2",
      "html_url":"https://getport-io.pagerduty.com/users/HDW63E2"
   },
   "start":"2024-02-25T00:00:00Z",
   "end":"2024-04-14T11:10:48Z"
}

Service response data

{
  "id": "PGAAJBE",
  "name": "My Test Service",
  "description": "For testing",
  "created_at": "2023-08-03T16:53:48+03:00",
  "updated_at": "2023-08-03T16:53:48+03:00",
  "status": "active",
  "teams": [],
  "alert_creation": "create_alerts_and_incidents",
  "addons": [],
  "scheduled_actions": [],
  "support_hours": "None",
  "last_incident_timestamp": "None",
  "escalation_policy": {
    "id": "P7LVMYP",
    "type": "escalation_policy_reference",
    "summary": "Test Escalation Policy",
    "self": "https://api.pagerduty.com/escalation_policies/P7LVMYP",
    "html_url": "https://getport-io.pagerduty.com/escalation_policies/P7LVMYP"
  },
  "incident_urgency_rule": {
    "type": "constant",
    "urgency": "high"
  },
  "acknowledgement_timeout": "None",
  "auto_resolve_timeout": "None",
  "integrations": [],
  "type": "service",
  "summary": "My Test Service",
  "self": "https://api.pagerduty.com/services/PGAAJBE",
  "html_url": "https://getport-io.pagerduty.com/service-directory/PGAAJBE",
  "__oncall_user": [
    {
      "escalation_policy": {
        "id": "P7LVMYP",
        "type": "escalation_policy_reference",
        "summary": "Test Escalation Policy",
        "self": "https://api.pagerduty.com/escalation_policies/P7LVMYP",
        "html_url": "https://getport-io.pagerduty.com/escalation_policies/P7LVMYP"
      },
      "escalation_level": 1,
      "schedule": {
        "id": "PWAXLIH",
        "type": "schedule_reference",
        "summary": "Port Test Service - Weekly Rotation",
        "self": "https://api.pagerduty.com/schedules/PWAXLIH",
        "html_url": "https://getport-io.pagerduty.com/schedules/PWAXLIH"
      },
      "user": {
        "name": "demo",
        "email": "devops-port@pager-demo.com",
        "time_zone": "Asia/Jerusalem",
        "color": "teal",
        "avatar_url": "https://secure.gravatar.com/avatar/5cc831a4e778f54460efc4cd20d13acd.png?d=mm&r=PG",
        "billed": true,
        "role": "admin",
        "description": "None",
        "invitation_sent": true,
        "job_title": "None",
        "teams": [],
        "contact_methods": [
          {
            "id": "POKPUFD",
            "type": "email_contact_method_reference",
            "summary": "Default",
            "self": "https://api.pagerduty.com/users/PYIEKLY/contact_methods/POKPUFD",
            "html_url": "None"
          }
        ],
        "notification_rules": [
          {
            "id": "P9NWEKF",
            "type": "assignment_notification_rule_reference",
            "summary": "0 minutes: channel POKPUFD",
            "self": "https://api.pagerduty.com/users/PYIEKLY/notification_rules/P9NWEKF",
            "html_url": "None"
          },
          {
            "id": "PPJHFA5",
            "type": "assignment_notification_rule_reference",
            "summary": "0 minutes: channel POKPUFD",
            "self": "https://api.pagerduty.com/users/PYIEKLY/notification_rules/PPJHFA5",
            "html_url": "None"
          }
        ],
        "id": "PYIEKLY",
        "type": "user",
        "summary": "demo",
        "self": "https://api.pagerduty.com/users/PYIEKLY",
        "html_url": "https://getport-io.pagerduty.com/users/PYIEKLY"
      },
      "start": "2023-10-17T15:57:50Z",
      "end": "2024-02-13T22:16:48Z"
    }
  ]
}

Incident response data

{
  "incident_number": 2,
  "title": "Example Incident",
  "description": "Example Incident",
  "created_at": "2023-05-15T13:59:45Z",
  "updated_at": "2023-05-15T13:59:45Z",
  "status": "triggered",
  "incident_key": "89809d37f4344d36a90c0a192c20c617",
  "service": {
    "id": "PWJAGSD",
    "type": "service_reference",
    "summary": "Port Test Service",
    "self": "https://api.pagerduty.com/services/PWJAGSD",
    "html_url": "https://getport-io.pagerduty.com/service-directory/PWJAGSD"
  },
  "assignments": [
    {
      "at": "2023-05-15T13:59:45Z",
      "assignee": {
        "id": "PJCRRLH",
        "type": "user_reference",
        "summary": "Username",
        "self": "https://api.pagerduty.com/users/PJCRRLH",
        "html_url": "https://getport-io.pagerduty.com/users/PJCRRLH"
      }
    }
  ],
  "assigned_via": "escalation_policy",
  "last_status_change_at": "2023-05-15T13:59:45Z",
  "resolved_at": null,
  "first_trigger_log_entry": {
    "id": "R5S5T07QR1SZRQFYB7SXEO2EKZ",
    "type": "trigger_log_entry_reference",
    "summary": "Triggered through the website.",
    "self": "https://api.pagerduty.com/log_entries/R5S5T07QR1SZRQFYB7SXEO2EKZ",
    "html_url": "https://getport-io.pagerduty.com/incidents/Q1P3AHC3KLGVAS/log_entries/R5S5T07QR1SZRQFYB7SXEO2EKZ"
  },
  "alert_counts": {
    "all": 0,
    "triggered": 0,
    "resolved": 0
  },
  "is_mergeable": true,
  "escalation_policy": {
    "id": "P7LVMYP",
    "type": "escalation_policy_reference",
    "summary": "Test Escalation Policy",
    "self": "https://api.pagerduty.com/escalation_policies/P7LVMYP",
    "html_url": "https://getport-io.pagerduty.com/escalation_policies/P7LVMYP"
  },
  "teams": [],
  "pending_actions": [],
  "acknowledgements": [],
  "basic_alert_grouping": null,
  "alert_grouping": null,
  "last_status_change_by": {
    "id": "PWJAGSD",
    "type": "service_reference",
    "summary": "Port Test Service",
    "self": "https://api.pagerduty.com/services/PWJAGSD",
    "html_url": "https://getport-io.pagerduty.com/service-directory/PWJAGSD"
  },
  "urgency": "high",
  "id": "Q1P3AHC3KLGVAS",
  "type": "incident",
  "summary": "[#2] Example Incident",
  "self": "https://api.pagerduty.com/incidents/Q1P3AHC3KLGVAS",
  "html_url": "https://getport-io.pagerduty.com/incidents/Q1P3AHC3KLGVAS"
}

Mapping Result

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

Schedule entity in Port

{
  "identifier": "PWAXLIH",
  "title": "Port Test Service - Weekly Rotation",
  "icon": null,
  "blueprint": "pagerdutySchedule",
  "team": [],
  "properties": {
    "url": "https://getport-io.pagerduty.com/schedules/PWAXLIH",
    "timezone": "Asia/Jerusalem",
    "description": "Asia/Jerusalem",
    "users": ["Adam", "Alice", "Doe", "Demo", "Pages"]
  },
  "relations": {},
  "createdAt": "2023-12-01T13:18:02.215Z",
  "createdBy": "hBx3VFZjqgLPEoQLp7POx5XaoB0cgsxW",
  "updatedAt": "2023-12-01T13:18:02.215Z",
  "updatedBy": "hBx3VFZjqgLPEoQLp7POx5XaoB0cgsxW"
}

Oncall entity in Port

{
  "identifier": "HDW63E2-PWAXLIH-2024-06-03T13:00:00Z",
  "title": "John Doe",
  "blueprint": "pagerdutyOncall",
  "team": [],
  "properties": {
    "url": "https://getport-io.pagerduty.com/schedules/PWAXLIH",
    "timezone": null,
    "description": "Port Test Service - Weekly Rotation",
    "user": "johndoe@domain.io",
    "startDate": "2024-06-03T13:00:00Z",
    "endDate": "2024-06-17T13:00:00Z"
  },
  "relations": {
    "pagerdutySchedule": "PWAXLIH"
  },
  "createdAt": "2024-03-08T15:52:35.807Z",
  "createdBy": "hBx3VFZjqgLPEoQLp7POx5XaoB0cgsxW",
  "updatedAt": "2024-03-08T15:52:35.807Z",
  "updatedBy": "hBx3VFZjqgLPEoQLp7POx5XaoB0cgsxW"
}

Service entity in Port

{
  "identifier": "PGAAJBE",
  "title": "My Test Service",
  "icon": null,
  "blueprint": "pagerdutyService",
  "team": [],
  "properties": {
    "status": "active",
    "url": "https://getport-io.pagerduty.com/service-directory/PGAAJBE",
    "oncall": "devops-port@pager-demo.com"
  },
  "relations": {},
  "createdAt": "2023-11-01T13:18:02.215Z",
  "createdBy": "hBx3VFZjqgLPEoQLp7POx5XaoB0cgsxW",
  "updatedAt": "2023-11-01T13:18:02.215Z",
  "updatedBy": "hBx3VFZjqgLPEoQLp7POx5XaoB0cgsxW"
}

Incident entity in Port

{
  "identifier": "Q1P3AHC3KLGVAS",
  "title": "Example Incident",
  "icon": null,
  "blueprint": "pagerdutyIncident",
  "team": [],
  "properties": {
    "status": "triggered",
    "url": "https://api.pagerduty.com/incidents/Q1P3AHC3KLGVAS",
    "urgency": "high",
    "responder": "Username",
    "escalation_policy": "Test Escalation Policy",
    "created_at": "2023-07-30T11:29:21.000Z",
    "updated_at": "2023-07-30T11:29:21.000Z"
  },
  "relations": {
    "pagerdutyService": "PWJAGSD"
  },
  "createdAt": "2023-08-07T07:56:04.384Z",
  "createdBy": "hBx3VFZjqgLPEoQLp7POx5XaoB0cgsxW",
  "updatedAt": "2023-08-07T07:56:04.384Z",
  "updatedBy": "hBx3VFZjqgLPEoQLp7POx5XaoB0cgsxW"
}

Alternative installation via webhook

While the Ocean integration described above is the recommended installation method, you may prefer to use a webhook to ingest data from PagerDuty. If so, use the following instructions:

Webhook installation (click to expand)

In this example you are going to create a webhook integration between PagerDuty and Port, which will ingest PagerDuty services and its related incidents into Port. This integration will involve setting up a webhook to receive notifications from PagerDuty whenever an incident is created or updated, allowing Port to ingest and process the incident entities accordingly.

Import PagerDuty services and incidents

Port configuration

Create the following blueprint definitions:

PagerDuty service blueprint

{
  "identifier": "microservice",
  "title": "Microservice",
  "icon": "Service",
  "schema": {
    "properties": {
      "status": {
        "title": "Status",
        "type": "string"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {
    "service": {
      "title": "Service URL",
      "calculation": "'https://api.pagerduty.com/services/' + .identifier",
      "type": "string",
      "format": "url"
    }
  },
  "relations": {}
}

PagerDuty incident blueprint

{
  "identifier": "pagerdutyIncident",
  "description": "This blueprint represents a PagerDuty incident in our software catalog",
  "title": "PagerDuty Incident",
  "icon": "pagerduty",
  "schema": {
    "properties": {
      "status": {
        "type": "string",
        "title": "Incident Status",
        "enum": [
          "triggered",
          "annotated",
          "acknowledged",
          "reassigned",
          "escalated",
          "reopened",
          "resolved"
        ]
      },
      "url": {
        "type": "string",
        "format": "url",
        "title": "Incident URL"
      },
      "details": {
        "type": "string",
        "title": "Details"
      },
      "priority": {
        "type": "string",
        "title": "Priority"
      },
      "urgency": {
        "type": "string",
        "title": "Incident Urgency",
        "enum": ["high", "low"]
      },
      "responder": {
        "type": "string",
        "title": "Assignee"
      },
      "escalation_policy": {
        "type": "string",
        "title": "Escalation Policy"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {
    "microservice": {
      "title": "Belongs To",
      "target": "microservice",
      "required": false,
      "many": true
    }
  }
}

Create the following webhook configuration using Port UI

PagerDuty webhook configuration

1. Basic details tab - fill the following details:

   1. Title : PagerDuty Mapper;
   2. Identifier : pagerduty_mapper;
   3. Description : A webhook configuration to map PagerDuty services and its related incidents to Port;
   4. Icon : Pagerduty;

2. Integration configuration tab - fill the following JQ mapping:

   [
     {
       "blueprint": "microservice",
       "filter": ".body.event.event_type | startswith(\"service\")",
       "entity": {
         "identifier": ".body.event.data.id",
         "title": ".body.event.data.summary",
         "properties": {
           "status": ".body.event.data.event_type"
         }
       }
     },
     {
       "blueprint": "pagerdutyIncident",
       "filter": ".body.event.event_type | startswith(\"incident\")",
       "entity": {
         "identifier": ".body.event.data.id",
         "title": ".body.event.data.title",
         "properties": {
           "status": ".body.event.data.status",
           "url": ".body.event.data.html_url",
           "details": ".body.event.data.title",
           "priority": ".body.event.data.priority",
           "urgency": ".body.event.data.urgency",
           "responder": ".body.event.data.assignees[0].summary",
           "escalation_policy": ".body.event.data.escalation_policy.summary"
         },
         "relations": {
           "microservice": ".body.event.data.service.id"
         }
       }
     }
   ]

3. Scroll down to Advanced settings and input the following details:

   1. secret: WEBHOOK_SECRET;
   2. Signature Header Name : X-Pagerduty-Signature;
   3. Signature Algorithm : Select sha256 from dropdown option;
   4. Signature Prefix : v1=
   5. Click Save at the bottom of the page.

   Remember to update the WEBHOOK_SECRET with the real secret you receive after subscribing to the webhook in PagerDuty.

Create a webhook in PagerDuty

1. Go to PagerDuty and select the account you want to configure the webhook for.
2. Navigate to Integrations in the navigation bar and click on Generic Webhooks (v3).
3. Click New Webhook and provide the following information:
   1. Webhook URL - enter the value of the url key you received after creating the webhook configuration.
   2. Scope Type - select whether you want to receive webhook events for a specific service (select Service if applicable) or for all services in your account (select Account if applicable).
   3. Description - provide an optional description for your webhook.
   4. Event Subscription - choose the event types you would like to subscribe to.
   5. Custom Header - enter any optional HTTP header to be added to your webhook payload.
4. Click Add webhook to create your webhook.
5. Alternatively, you can use the curl method to create the webhook. Copy the code below and run it in your terminal:

  curl --request POST \
  --url \
 https://api.pagerduty.com/webhook_subscriptions
  --header 'Accept: application/vnd.pagerduty+json;version=2' \
  --header 'Authorization: Token token=<YOUR_PAGERDUTY_API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data \
 '{
  "webhook_subscription": {
  "delivery_method": {
    "type": "http_delivery_method",
    "url": "https://ingest.getport.io/<YOUR_PORT_WEBHOOK_KEY>",
    "custom_headers": [
      {
        "name": "your-header-name",
        "value": "your-header-value"
      }
    ]
  },
  "description": "Sends PagerDuty v3 webhook events to Port.",
  "events": [
      "service.created",
      "service.updated",
      "incident.triggered",
      "incident.responder.added",
      "incident.acknowledged",
      "incident.annotated",
      "incident.delegated",
      "incident.escalated",
      "incident.priority_updated",
      "incident.reassigned",
      "incident.reopened",
      "incident.resolved",
      "incident.responder.replied",
      "incident.status_update_published",
      "incident.unacknowledged"
  ],
  "filter": {
    "type": "account_reference"
  },
  "type": "webhook_subscription"
  }
  }'

tip

In order to view the different events available in PagerDuty webhooks, look here

Done! any change that happens to your services or incidents in PagerDuty will trigger a webhook event to the webhook URL provided by Port. Port will parse the events according to the mapping and update the catalog entities accordingly.

Let's Test It

This section includes a sample webhook event sent from PagerDuty when an incident is created or updated. In addition, it includes the entity created from the event based on the webhook configuration provided in the previous section.

Payload

Here is an example of the payload structure sent to the webhook URL when a PagerDuty incident is created:

Webhook event payload

{
  "event": {
    "id": "01DVUHO6P4XQDFJ9AHOADT3UQ4",
    "event_type": "incident.triggered",
    "resource_type": "incident",
    "occurred_at": "2023-06-12T11:56:08.355Z",
    "agent": {
      "html_url": "https://your_account.pagerduty.com/users/PJCRRLH",
      "id": "PJCRRLH",
      "self": "https://api.pagerduty.com/users/PJCRRLH",
      "summary": "username",
      "type": "user_reference"
    },
    "client": "None",
    "data": {
      "id": "Q01J2OS7YBWLNY",
      "type": "incident",
      "self": "https://api.pagerduty.com/incidents/Q01J2OS7YBWLNY",
      "html_url": "https://your_account.pagerduty.com/incidents/Q01J2OS7YBWLNY",
      "number": 7,
      "status": "triggered",
      "incident_key": "acda20953f7446248f90260db65144f8",
      "created_at": "2023-06-12T11:56:08Z",
      "title": "Test PagerDuty Incident",
      "service": {
        "html_url": "https://your_account.pagerduty.com/services/PWJAGSD",
        "id": "PWJAGSD",
        "self": "https://api.pagerduty.com/services/PWJAGSD",
        "summary": "Port Internal Service",
        "type": "service_reference"
      },
      "assignees": [
        {
          "html_url": "https://your_account.pagerduty.com/users/PRGAUI4",
          "id": "PRGAUI4",
          "self": "https://api.pagerduty.com/users/PRGAUI4",
          "summary": "username",
          "type": "user_reference"
        }
      ],
      "escalation_policy": {
        "html_url": "https://your_account.pagerduty.com/escalation_policies/P7LVMYP",
        "id": "P7LVMYP",
        "self": "https://api.pagerduty.com/escalation_policies/P7LVMYP",
        "summary": "Test Escalation Policy",
        "type": "escalation_policy_reference"
      },
      "teams": [],
      "priority": "None",
      "urgency": "high",
      "conference_bridge": "None",
      "resolve_reason": "None"
    }
  }
}

Mapping Result

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

{
  "identifier": "Q01J2OS7YBWLNY",
  "title": "Test PagerDuty Incident",
  "blueprint": "pagerdutyIncident",
  "team": [],
  "properties": {
    "status": "triggered",
    "url": "https://your_account.pagerduty.com/incidents/Q01J2OS7YBWLNY",
    "details": "Test PagerDuty Incident",
    "urgency": "high",
    "responder": "Username",
    "escalation_policy": "Test Escalation Policy"
  },
  "relations": {
    "microservice": "PWJAGSD"
  }
}

Import PagerDuty historical data

In this example you are going to use the provided Bash script to fetch data from the PagerDuty API and ingest it to Port.

The script extracts services and incidents from PagerDuty, and sends them to Port as microservice and incident entities respectively.

Port configuration

This example utilizes the same blueprint definition from the previous section, along with a new webhook configuration:

Create the following webhook configuration using Port UI

PagerDuty webhook configuration for historical data

1. Basic details tab - fill the following details:

   1. Title : PagerDuty History Mapper;
   2. Identifier : pagerduty_history_mapper;
   3. Description : A webhook configuration to map PagerDuty Historical services and its related incidents to Port;
   4. Icon : Pagerduty;

2. Integration configuration tab - fill the following JQ mapping:

   [
     {
       "blueprint": "microservice",
       "filter": ".body.event.event_type | startswith(\"service\")",
       "entity": {
         "identifier": ".body.event.data.identifier",
         "title": ".body.event.data.title",
         "properties": {
           "status": ".body.event.data.properties.status"
         }
       }
     },
     {
       "blueprint": "pagerdutyIncident",
       "filter": ".body.event.event_type | startswith(\"incident\")",
       "entity": {
         "identifier": ".body.event.data.identifier",
         "title": ".body.event.data.title",
         "properties": {
           "status": ".body.event.data.properties.status",
           "url": ".body.event.data.properties.url",
           "details": ".body.event.data.properties.details",
           "priority": ".body.event.data.properties.priority",
           "urgency": ".body.event.data.properties.urgency",
           "responder": ".body.event.data.properties.responder",
           "escalation_policy": ".body.event.data.properties.escalation_policy"
         },
         "relations": {
           "microservice": ".body.event.data.relations.microservice"
         }
       }
     }
   ]

3. Scroll down to Advanced settings and input the following details:

   1. secret: WEBHOOK_SECRET;
   2. Signature Header Name : X-Pagerduty-Signature;
   3. Signature Algorithm : Select sha256 from dropdown option;
   4. Signature Prefix : v1=
   5. Click Save at the bottom of the page.

Remember to update the WEBHOOK_SECRET with the real secret you receive after subscribing to the webhook in PagerDuty.

PagerDuty Bash script for historical data

#!/bin/bash

set -e
# PagerDuty API endpoints and token
PD_API_SERVICES='https://api.pagerduty.com/services'
PD_API_INCIDENTS='https://api.pagerduty.com/incidents'
PD_TOKEN='API_TOKEN'

# Port webhook URL
PORT_URL='https://ingest.getport.io/WEBHOOK_SECRET'

# Fetch services from PagerDuty
services=$(curl --silent --header "Authorization: Token token=${PD_TOKEN}" --header "Accept: application/vnd.pagerduty+json;version=2" --request GET ${PD_API_SERVICES})

# Extract services array
services_list=$(echo ${services} | jq '.services')

# Iterate over services and push to Port
for i in $(seq 0 $(($(echo ${services_list} | jq '. | length') - 1)))
do
    service=$(echo ${services_list} | jq ".[$i]")

    # Prepare payload for Port
    payload=$(jq -n \
                  --arg id "$(echo ${service} | jq -r '.id')" \
                  --arg name "$(echo ${service} | jq -r '.name')" \
                  --arg status "$(echo ${service} | jq -r '.status')" \
                  '{event: {event_type: "service", data: {identifier: $id, title: $name, properties: {status: $status}}}}')

    # Push to Port
    curl --silent --header 'Content-Type: application/json' --request POST --data "${payload}" ${PORT_URL}

    # Output payload to output.json file
    echo ${payload} >> output.json
done

# Fetch incidents from PagerDuty
incidents=$(curl --silent --header "Authorization: Token token=${PD_TOKEN}" --header "Accept: application/vnd.pagerduty+json;version=2" --request GET ${PD_API_INCIDENTS})

# Extract incidents array
incidents_list=$(echo ${incidents} | jq '.incidents')

# Iterate over incidents and push to Port
for i in $(seq 0 $(($(echo ${incidents_list} | jq '. | length') - 1)))
do
    incident=$(echo ${incidents_list} | jq ".[$i]")

    # Prepare payload for Port
    payload=$(jq -n \
                  --arg id "$(echo ${incident} | jq -r '.id')" \
                  --arg title "$(echo ${incident} | jq -r '.title')" \
                  --arg status "$(echo ${incident} | jq -r '.status')" \
                  --arg url "$(echo ${incident} | jq -r '.html_url')" \
                  --arg description "$(echo ${incident} | jq -r '.description')" \
                  --arg urgency "$(echo ${incident} | jq -r '.urgency')" \
                  --arg responder "$(echo ${incident} | jq -r '.last_status_change_by.summary')" \
                  --arg escalation_policy "$(echo ${incident} | jq -r '.escalation_policy.summary')" \
                  --arg service "$(echo ${incident} | jq -r '.service.id')" \
                  '{event: {event_type: "incident", data: {identifier: $id, title: $title, properties: {status: $status, url: $url, details: $description, urgency: $urgency, responder: $responder, escalation_policy: $escalation_policy}, relations: {microservice: $service}}}}')

    # Push to Port
    curl  --header 'Content-Type: application/json' --request POST --data "${payload}" ${PORT_URL}

    # Output payload to output.json file
    echo ${payload} >> output.json
done

How to Run the script

This script requires two configuration values:

1. PD_TOKEN: your PagerDuty API token;
2. PORT_URL: your Port webhook URL.

Then trigger the script by running:

bash pagerduty_to_port.sh

This script fetches services and incidents from PagerDuty and sends them to Port.

tip

The script writes the JSON payload for each service and incident to a file named output.json. This can be useful for debugging if you encounter any issues.

Done! you can now import historical data from PagerDuty into Port. Port will parse the events according to the mapping and update the catalog entities accordingly.

More relevant guides and examples

• Ensure production readniness
• Self-service action to escalate a PagerDuty incident
• Self-service action to trigger a PagerDuty incident
• Self-service action to change a PagerDuty incident owner
• Self-service action to create a PagerDuty service from Port