Add Note to Alert with Opsgenie API on New On-Call Rotation from PagerDuty API

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

Trigger workflow on

New On-Call Rotation from the PagerDuty API

Next, do this

Add Note to Alert with the Opsgenie 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#

This integration creates a workflow with a PagerDuty trigger and Opsgenie action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New On-Call Rotation trigger
1. Connect your PagerDuty account
2. Optional- Select one or more Escalation Policies
3. Configure Interval to poll for new rotations
Configure the Add Note to Alert action
1. Connect your Opsgenie account
2. Select a Alert ID
3. Configure Note
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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#

New On-Call Rotation on PagerDuty

Description:Emit new event each time a new user rotates onto an on-call rotation

Version:0.1.1

Key:pagerduty-new-oncall-rotation

View on GitHub

PagerDuty Overview#

The PagerDuty API offers a powerful interface to automate your digital operations management. By leveraging its capabilities on Pipedream, you can create workflows that respond to incidents, automate alerts, and synchronize incident data across various platforms. PagerDuty's API enables you to manage services, teams, and incidents, ensuring that your systems remain operational and that the right people are notified at the right time.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import differenceBy from "lodash.differenceby";
import pagerduty from "../../pagerduty.app.mjs";
import common from "../common.mjs";

export default {
  ...common,
  key: "pagerduty-new-oncall-rotation",
  name: "New On-Call Rotation",
  version: "0.1.1",
  description: "Emit new event each time a new user rotates onto an on-call rotation",
  type: "source",
  props: {
    ...common.props,
    pagerduty,
    db: "$.service.db",
    escalationPoliciesIds: {
      type: "string[]",
      label: "Escalation Policies",
      description: "To filter your on-call rotations to specific escalation policies, select them here. **To listen for rotations across all escalation policies, leave this blank**.",
      propDefinition: [
        pagerduty,
        "escalationPolicyId",
      ],
    },
    timer: {
      type: "$.interface.timer",
      label: "Interval to poll for new rotations",
      description:
        "The PagerDuty API doesn't support webhook notifications for on-call rotations, so we must poll the API to check for these changes. Change this interval according to your needs.",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run() {
    // If the user didn't watch specific escalation policies,
    // iterate through all of the policies on the account
    const escalationPoliciesIds =
      this.escalationPoliciesIds?.length
        ? this.escalationPoliciesIds
        : await this.pagerduty.listEscalationPoliciesIds();

    // Since we can watch multiple escalation policies for rotations, we must
    // keep track of the last users who were on-call for a given policy.
    const oncallUsersByEscalationPolicy = this.getOncallUsersByEscalationPolicy() || {};

    for (const escalationPolicyId of escalationPoliciesIds) {
      // Multiple users can technically be on-call at the same time if the account
      // has multiple schedules attached to an escalation policy, so we must watch
      // for any new users in the list of on-call users who were not in the list of
      // users previously on-call. See
      // https://community.pagerduty.com/forum/t/how-do-i-add-more-than-one-person-on-call-for-a-schedule/751
      const oncallUsers = await this.pagerduty.listOncallUsers({
        params: {
          escalation_policy_ids: [
            escalationPolicyId,
          ],
        },
      });
      const previousUsersOncall = oncallUsersByEscalationPolicy[escalationPolicyId] || [];

      // Retrieve the list of users who were previously not on-call,
      // but now entered the rotation
      const newOncallUsers = differenceBy(
        oncallUsers,
        previousUsersOncall,
        "id",
      );

      oncallUsersByEscalationPolicy[escalationPolicyId] = oncallUsers;

      if (!newOncallUsers.length) {
        console.log(`No change to on-call users for escalation policy ${escalationPolicyId}`);
        continue;
      }

      // Include escalation policy metadata in emit
      const escalationPolicy =
        await this.pagerduty.getEscalationPolicy({
          escalationPolicyId,
        });

      newOncallUsers.forEach((user) => {
        this.$emit({
          user,
          escalationPolicy,
        }, {
          summary: `${user.summary} is now on-call for escalation policy ${escalationPolicy.name}`,
        });
      });
    }

    // Persist the new set of on-call users for the next run
    this.setOncallUsersByEscalationPolicy(oncallUsersByEscalationPolicy);
  },
};

Trigger 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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Escalation Policies	`escalationPoliciesIds`	`string[]`	Select a value from the drop down menu.
Interval to poll for new rotations	`timer`	`$.interface.timer`	The PagerDuty API doesn't support webhook notifications for on-call rotations, so we must poll the API to check for these changes. Change this interval according to your needs.

Trigger 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:

About PagerDuty#

Real-Time Operations and Incident Response

Action#

Add Note to Alert on Opsgenie

Description:Adds a note to an existing alert in Opsgenie. [See the documentation](https://docs.opsgenie.com/docs/alert-api#add-note-to-alert)

Version:0.0.2

Key:opsgenie-add-note-alert

View on GitHub

Opsgenie Overview#

The Opsgenie API enables automated incident management and alerting to streamline response actions. It allows you to create, update, and manage alerts, as well as configure and query users, schedules, and on-call rotations. Integrating Opsgenie with Pipedream opens up possibilities for orchestrating complex workflows, such as incident triggering from various sources, auto-update of tickets, synchronization with other tools, and much more, all in a serverless environment.

Action Code#

import opsgenie from "../../opsgenie.app.mjs";

export default {
  key: "opsgenie-add-note-alert",
  name: "Add Note to Alert",
  description: "Adds a note to an existing alert in Opsgenie. [See the documentation](https://docs.opsgenie.com/docs/alert-api#add-note-to-alert)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    opsgenie,
    alertId: {
      propDefinition: [
        opsgenie,
        "alertId",
      ],
    },
    note: {
      type: "string",
      label: "Note",
      description: "Alert note to add",
    },
  },
  async run({ $ }) {
    const response = await this.opsgenie.addNoteToAlert({
      $,
      alertId: this.alertId,
      data: {
        note: this.note,
      },
    });
    $.export("$summary", `Successfully added note to alert with ID: ${this.alertId}`);
    return response;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Opsgenie	`opsgenie`	`app`	This component uses the Opsgenie app.
Alert ID	`alertId`	`string`	Select a value from the drop down menu.
Note	`note`	`string`	Alert note to add

Action Authentication#

Opsgenie uses API keys for authentication. When you connect your Opsgenie account, Pipedream securely stores the keys so you can easily authenticate to Opsgenie APIs in both code and no-code steps.

Opsgenie uses two sets of API Keys for different purposes - the Global API Key is primarily used for global configuration management, and the Team API Key is tied directly to a given team. To learn about the difference between Global API Key and Team API Key, see the docs here

Please note, that you will need to provide your Team API Key to Create Alert, Acknowledge Alert, or Close Alert as those API calls are restricted to Team API Keys.