Check for existence of key with Data Stores API on New On-Call Rotation from PagerDuty API

Pipedream makes it easy to connect APIs for Data Stores, PagerDuty and 1000+ other apps remarkably fast.

Trigger workflow on

New On-Call Rotation from the PagerDuty API

Next, do this

Check for existence of key with the Data Stores API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a PagerDuty trigger and Data Stores 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 Check for existence of key action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Optional- Select a Create a new record if the key is not found?
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#

PagerDuty's APIs allow you to integrate the powerful incident response
capabilities of PagerDuty with your own custom applications. With PagerDuty's
APIs, you can build applications to optimize your incident response process,
collaborate with teams more effectively, and analyze data from your incident
response process. Here are some examples of what you can do with PagerDuty's
APIs:

Create and manage automated incident response workflows
Automatically trigger actions based on incident response events
Enable communication between PagerDuty and other third party applications
Pull data from your previous incident response processes to identify best
practices
Create custom reporting tools and insights into incident response processes
Monitor multiple teams and services at once

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#

Check for existence of key on Data Stores

Description:Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.

Version:0.1.1

Key:data_stores-has-key-or-create

View on GitHub

Data Stores Overview#

With the Data Stores API, you can build applications that:

Store data for later retrieval
Retrieve data from a store
Update data in a store
Delete data from a store

Action Code#

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

export default {
  key: "data_stores-has-key-or-create",
  name: "Check for existence of key",
  description: "Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.",
  version: "0.1.1",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter the key you'd like to check.",
    },
    addRecordIfNotFound: {
      propDefinition: [
        app,
        "addRecordIfNotFound",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      props.value = app.propDefinitions.value;
    }
    return props;
  },
  async run({ $ }) {
    if (await this.dataStore.has(this.key)) {
      $.export("$summary", `Key \`${this.key}\` exists.`);

      return {
        existingKeyFound: true,
        newKeyCreated: false,
      };
    }

    if (!this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      $.export("$summary", `Key \`${this.key}\` does not exist.`);

      return {
        existingKeyFound: false,
        newKeyCreated: false,
      };
    }

    const parsedValue = this.app.parseValue(this.value);
    await this.dataStore.set(this.key, parsedValue);
    $.export("$summary", `Key \`${this.key}\` was not found. Successfully added a new record.`);

    return {
      existingKeyFound: false,
      newKeyCreated: true,
      value: parsedValue,
    };
  },
};

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
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Create a new record if the key is not found?	`addRecordIfNotFound`	`string`	Select a value from the drop down menu:`YesNo`