Trigger Incident with PagerDuty API

Pipedream makes it easy to connect APIs for PagerDuty and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Trigger Incident with the PagerDuty API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Trigger Incident with the PagerDuty API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Trigger Incident action
1. Connect your PagerDuty account
2. Configure Incident Title
3. Select a Service ID
4. Optional- Select a Incident Urgency
5. Optional- Configure Incident Details
6. Optional- Configure Incident Key
7. Optional- Select a Escalation Policy ID
8. Select one or more Assignee IDs
9. Optional- Configure Incident Conference Bridge Number
10. Optional- Configure Incident Conference Bridge URL
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Trigger Incident with PagerDuty API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + PagerDuty

Try it

Trigger Incident with PagerDuty API on New Item in Feed from RSS API

RSS + PagerDuty

Try it

Trigger Incident with PagerDuty API on New Message from Discord API

Discord + PagerDuty

Try it

Trigger Incident with PagerDuty API on New Message In Channels from Slack API

Slack + PagerDuty

Try it

Trigger Incident with PagerDuty API on New Message in Channel from Discord Bot API

Discord Bot + PagerDuty

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger Incident on PagerDuty

Description:Trigger an incident. [See the docs here](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODE0MA-create-an-incident)

Version:0.0.2

Key:pagerduty-trigger-incident

View on GitHub

Code#

import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";
import pagerduty from "../../pagerduty.app.mjs";

const {
  reduceProperties,
  emptyStrToUndefined,
  commaSeparatedListToArray,
} = utils;

export default {
  key: "pagerduty-trigger-incident",
  name: "Trigger Incident",
  description: "Trigger an incident. [See the docs here](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODE0MA-create-an-incident)",
  type: "action",
  version: "0.0.2",
  props: {
    pagerduty,
    title: {
      propDefinition: [
        pagerduty,
        "incidentTitle",
      ],
    },
    serviceId: {
      propDefinition: [
        pagerduty,
        "serviceId",
      ],
    },
    urgency: {
      propDefinition: [
        pagerduty,
        "incidentUrgency",
      ],
    },
    bodyDetails: {
      propDefinition: [
        pagerduty,
        "incidentBodyDetails",
      ],
    },
    incidentKey: {
      propDefinition: [
        pagerduty,
        "incidentKey",
      ],
    },
    escalationPolicyId: {
      propDefinition: [
        pagerduty,
        "escalationPolicyId",
      ],
    },
    assigneeIds: {
      type: "string[]",
      label: "Assignee IDs",
      description: "The IDs of the users to assign to the incident. Use a comma-separated list when structured mode is `off` specifying the ids as values. (e.g. `P97DSQO,PWLDHXC,P1M4QLY`)",
      propDefinition: [
        pagerduty,
        "userId",
      ],
    },
    conferenceBridgeNumber: {
      propDefinition: [
        pagerduty,
        "incidentConferenceBridgeNumber",
      ],
    },
    conferenceBridgeUrl: {
      propDefinition: [
        pagerduty,
        "incidentConferenceBridgeUrl",
      ],
    },
  },
  async run({ $ }) {
    const {
      title,
      serviceId,
    } = this;

    const conferenceBridgeNumber = emptyStrToUndefined(this.conferenceBridgeNumber);
    const conferenceBridgeUrl = emptyStrToUndefined(this.conferenceBridgeUrl);
    const escalationPolicyId = emptyStrToUndefined(this.escalationPolicyId);
    const bodyDetails = emptyStrToUndefined(this.bodyDetails);
    const urgency = emptyStrToUndefined(this.urgency);
    const incidentKey = emptyStrToUndefined(this.incidentKey);
    const assigneeIds = commaSeparatedListToArray(this.assigneeIds);

    const initialProps = {
      type: constants.INCIDENT_TYPE,
      title,
      service: {
        id: serviceId,
        type: constants.REFERENCE.SERVICE,
      },
    };

    const additionalProps = {
      urgency,
      incident_key: incidentKey,
      body: [
        {
          type: constants.INCIDENT_BODY_TYPE,
          details: bodyDetails,
        },
        bodyDetails,
      ],
      assignments: [
        assigneeIds?.map((id) => ({
          assignee: {
            id,
            type: constants.REFERENCE.USER,
          },
        })),
        assigneeIds?.length && !escalationPolicyId,
      ],
      escalation_policy: [
        {
          id: escalationPolicyId,
          type: constants.REFERENCE.ESCALATION_POLICY,
        },
        escalationPolicyId,
      ],
      conference_bridge: [
        {
          conference_number: conferenceBridgeNumber,
          conference_url: conferenceBridgeUrl,
        },
        conferenceBridgeNumber || conferenceBridgeUrl,
      ],
    };

    const toCreate = reduceProperties({
      initialProps,
      additionalProps,
    });

    const { incident } = await this.pagerduty.createIncident({
      $,
      data: {
        incident: toCreate,
      },
    });

    $.export("$summary", `Incident ${incident.summary} has been ${incident.status}`);

    return incident;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
PagerDuty	`pagerduty`	`app`	This component uses the PagerDuty app.
Incident Title	`title`	`string`	A succinct description of the nature, symptoms, cause, or effect of the incident.
Service ID	`serviceId`	`string`	Select a value from the drop down menu.
Incident Urgency	`urgency`	`string`	Select a value from the drop down menu:`{ "label": "High", "value": "high" }{ "label": "Low", "value": "low" }`
Incident Details	`bodyDetails`	`string`	Additional incident details.
Incident Key	`incidentKey`	`string`	A string which identifies the incident. Sending subsequent requests referencing the same service and with the same Incident Key will result in those requests being rejected if an open incident matches that Incident Key.
Escalation Policy ID	`escalationPolicyId`	`string`	Select a value from the drop down menu.
Assignee IDs	`assigneeIds`	`string[]`	Select a value from the drop down menu.
Incident Conference Bridge Number	`conferenceBridgeNumber`	`string`	The phone number of the conference call for the conference bridge. Phone numbers should be formatted like `+1 415-555-1212,,,,1234#`, where a comma (`,`) represents a one-second wait and pound (`#`) completes access code input.
Incident Conference Bridge URL	`conferenceBridgeUrl`	`string`	An URL for the conference bridge. This could be a link to a web conference or Slack channel.

Authentication#

PagerDuty uses OAuth authentication. When you connect your PagerDuty account, Pipedream will open a popup window where you can sign into PagerDuty and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any PagerDuty API.

Pipedream requests the following authorization scopes when you connect your account: