Continue execution if a condition Is met with Filter API on New On-Call Rotation from PagerDuty API

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

Trigger workflow on

New On-Call Rotation from the PagerDuty API

Next, do this

Continue execution if a condition Is met with the Filter API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a PagerDuty trigger and Filter 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 Continue execution if a condition Is met action
1. Connect your Filter account
2. Optional- Configure Reason for continuing
3. Optional- Configure Reason for ending
4. Configure Initial value
5. Select a Condition
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#

Continue execution if a condition Is met on Filter

Description:Continue workflow execution only if a condition is met

Version:0.0.2

Key:filter-continue-based-on-condition

View on GitHub

Filter Overview#

The Filter API is a great way to build powerful workflows that can manipulate
and transform data. Here are some examples of what you can build using the
Filter API:

A workflow that transforms data from one format to another
A workflow that filters out data that does not meet certain criteria
A workflow that sorts data in a specific order
A workflow that calculates statistics or aggregates data
A workflow that combines data from multiple sources

Action Code#

import common from "../common/common.mjs";

export default {
  ...common,
  name: "Continue execution if a condition Is met",
  version: "0.0.2",
  key: "filter-continue-based-on-condition",
  description: "Continue workflow execution only if a condition is met",
  type: "action",
  methods: {
    consolidateResult($, result) {
      !result && $.flow.exit(this.messageOnEnd);
      return this.messageOnContinue;
    },
  },
};

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
Filter	`filter`	`app`	This component uses the Filter app.
Reason for continuing	`messageOnContinue`	`string`	The message that will be displayed when the workflow continues
Reason for ending	`messageOnEnd`	`string`	The message that will be displayed when the workflow ends
Initial value	`initialValue`	`any`	The 1st of 2 values to compare
Condition	`condition`	`string`	Select a value from the drop down menu:`{ "label": "[Text] Contains", "value": "CONTAINS" }{ "label": "[Text] Does not contain", "value": "NOT_CONTAINS" }{ "label": "[Text] Matches exactly", "value": "TEXT_EQUALS" }{ "label": "[Text] Does not exactly match", "value": "TEXT_NOT_EQUALS" }{ "label": "[Text] Starts with", "value": "STARTS_WITH" }{ "label": "[Text] Does not start with", "value": "NOT_STARTS_WITH" }{ "label": "[Text] Ends with", "value": "ENDS_WITH" }{ "label": "[Text] Does not end with", "value": "NOT_ENDS_WITH" }{ "label": "[Number] Is greater than", "value": "GREATER_THAN" }{ "label": "[Number] Is greater than or equal to", "value": "GREATER_THAN_EQUALS" }{ "label": "[Number] Is less than", "value": "LESS_THAN" }{ "label": "[Number] Is less than or equal to", "value": "LESS_THAN_EQUALS" }{ "label": "[Number] Is equal to", "value": "EQUALS" }{ "label": "[Array] Is present in array", "value": "IN_ARRAY" }{ "label": "[Array] Is not present in array", "value": "NOT_IN_ARRAY" }{ "label": "[Object] Key exists and is not null or undefined", "value": "KEY_EXISTS" }{ "label": "[Object] Key does not exist or value is null or undefined", "value": "KEY_NOT_EXISTS" }{ "label": "[Boolean] Evaluates to True", "value": "TRUE" }{ "label": "[Boolean] Evaluates to False", "value": "FALSE" }{ "label": "[Null] Is null or undefined", "value": "IS_NULL" }{ "label": "[Null] Is not null or undefined", "value": "NOT_NULL" }`