Skip to main content

Check out Port for yourself 

Trigger a PagerDuty Incident

Overview​

This guide will help you implement a self-service action in Port that allows you to trigger PagerDuty incidents directly from Port. This functionality streamlines incident management by enabling users to trigger incidents without leaving Port.

You can implement this action in two ways:

  1. GitHub workflow: A more flexible approach that allows for complex workflows and custom logic, suitable for teams that want to maintain their automation in Git.
  2. Synced webhooks: A simpler approach that directly interacts with PagerDuty's API through Port, ideal for quick implementation and minimal setup.

Prerequisites​

  • Complete the onboarding process.

  • Access to your PagerDuty organization with permissions to manage incidents.

  • A PagerDuty routing key for the service you want to trigger incidents for.

    Finding your PagerDuty routing key

    To find your PagerDuty routing key (also called integration key):

    • Log in to your PagerDuty account
    • Navigate to Services in the main menu
    • Select the service you want to trigger incidents for
    • Click on the Integrations tab
    • Look for an existing "Events API V2" integration, or click Add integration and select "Events API V2"
    • The Integration Key displayed is your routing key

  • Optional - Install Port's PagerDuty integration learn more

    PagerDuty Integration

    This step is not required for this example, but it will create all the blueprint boilerplate for you, and also ingest and update the catalog in real time with your PagerDuty Incidents.

Set up data model​

If you haven't installed the PagerDuty integration, you'll need to create blueprints for PagerDuty incidents. However, we highly recommend you install the PagerDuty integration to have these automatically set up for you.

Create the PagerDuty incident blueprint

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

Implementation​

You can trigger PagerDuty incidents by leveraging Port's synced webhooks and secrets to directly interact with the PagerDuty's API. This method simplifies the setup by handling everything within Port.

Add Port secrets

Existing secrets

If you have already installed Port's PagerDuty integration, these secrets should already exist in your portal.
To view your existing secrets:

  1. Click on the ... button in the top right corner of your Port application.
  2. Choose Credentials, then click on the Secrets tab.

To add these secrets to your portal:

  1. Click on the ... button in the top right corner of your Port application.

  2. Click on Credentials.

  3. Click on the Secrets tab.

  4. Click on + Secret and add the following secrets:

    • PAGERDUTY_ROUTING_KEY: Your PagerDuty routing key for the service.

Set up self-service action

We will create a self-service action to handle triggering PagerDuty incidents using webhooks. To create a self-service action follow these steps:

  1. Head to the self-service page.

  2. Click on the + New Action button.

  3. Click on the {...} Edit JSON button.

  4. Copy and paste the following JSON configuration into the editor.

    Trigger PagerDuty Incident (Webhook) (Click to expand)
    {
      "identifier": "trigger_incident_webhook",
      "title": "Trigger Incident (Webhook)",
      "icon": "pagerduty",
      "description": "Trigger a new PagerDuty incident",
      "trigger": {
        "type": "self-service",
        "operation": "DAY-2",
        "userInputs": {
          "properties": {
            "summary": {
              "icon": "DefaultProperty",
              "title": "Summary",
              "type": "string"
            },
            "source": {
              "icon": "DefaultProperty",
              "title": "Source",
              "type": "string",
              "default": "Port"
            },
            "severity": {
              "icon": "DefaultProperty",
              "title": "Severity",
              "type": "string",
              "default": "critical",
              "enum": [
                "critical",
                "error",
                "warning",
                "info"
              ],
              "enumColors": {
                "critical": "red",
                "error": "red",
                "warning": "yellow",
                "info": "blue"
              }
            },
            "event_action": {
              "icon": "DefaultProperty",
              "title": "Event Action",
              "type": "string",
              "default": "trigger",
              "enum": [
                "trigger",
                "acknowledge",
                "resolve"
              ]
            }
          },
          "required": [
            "summary",
            "source",
            "severity",
            "event_action"
          ],
          "order": [
            "summary",
            "source",
            "severity",
            "event_action"
          ]
        },
        "blueprintIdentifier": "pagerdutyIncident"
      },
      "invocationMethod": {
        "type": "WEBHOOK",
        "url": "https://events.pagerduty.com/v2/enqueue",
        "agent": false,
        "synchronized": true,
        "method": "POST",
        "headers": {
          "Content-Type": "application/json"
        },
        "body": {
          "payload": {
            "summary": "{{.inputs.summary}}",
            "source": "{{.inputs.source}}",
            "severity": "{{.inputs.severity}}"
          },
          "routing_key": "{{.secrets.PAGERDUTY_ROUTING_KEY}}",
          "event_action": "{{.inputs.event_action}}"
        }
      },
      "requiredApproval": false
    }

  5. Click Save.

Now you should see the Trigger Incident (Webhook) action in the self-service page. 🎉

Create an automation to upsert entity in port

After each execution of the action, we would like to update the relevant entity in Port with the latest status.

To achieve this, we can create an automation that will be triggered when the action completes successfully.

To create the automation:

  1. Head to the automation page.

  2. Click on the + Automation button.

  3. Copy and paste the following JSON configuration into the editor.

    Update PagerDuty incident in Port automation (Click to expand)
    {
      "identifier": "pagerdutyIncident_sync_after_trigger",
      "title": "Sync PagerDuty Incident After Trigger",
      "description": "Update PagerDuty incident data in Port after triggering",
      "trigger": {
        "type": "automation",
        "event": {
          "type": "RUN_UPDATED",
          "actionIdentifier": "trigger_incident_webhook"
        },
        "condition": {
          "type": "JQ",
          "expressions": [
            ".diff.after.status == \"SUCCESS\""
          ],
          "combinator": "and"
        }
      },
      "invocationMethod": {
        "type": "UPSERT_ENTITY",
        "blueprintIdentifier": "pagerdutyIncident",
        "mapping": {
          "identifier": "{{.event.diff.after.response.dedup_key}}",
          "title": "{{.event.diff.after.properties.summary}}",
          "properties": {
            "status": "triggered",
            "urgency": "high",
            "created_at": "{{.event.diff.after.createdAt}}"
          }
        }
      },
      "publish": true
    }

  4. Click Save.

Now when you execute the webhook action, the incident data in Port will be automatically updated with the latest information from PagerDuty.

Let's test it!​

  1. Head to the self-service page of your portal

  2. Choose either the GitHub workflow or webhook implementation:

    • For GitHub workflow: Click on Trigger Incident
    • For webhook: Click on Trigger Incident (Webhook)

  3. Choose the pagerduty incident you want to trigger (In case you didn't install the PagerDuty integration, it means you don't have any PagerDuty incidents in Port yet, so you will need to create one manually in Port to test this action)

  4. Enter the required information:

    • For GitHub workflow: Enter the summary, source, severity, event action, and routing key
    • For webhook: Enter the summary, source, severity, and event action

  5. Click on Execute

  6. Done! wait for the incident's status to be changed in PagerDuty

More Self Service PagerDuty Actions Examples​