List Records with Data Stores API on New or Updated Incident from PagerDuty API

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

Trigger workflow on

New or Updated Incident from the PagerDuty API

Next, do this

List Records with the Data Stores 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 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 or Updated Incident trigger
1. Connect your PagerDuty account
2. Select a Service ID
3. Optional- Select one or more Events
Configure the List Records action
1. Connect your Data Stores account
2. Configure Data Store
3. Select one or more Key
4. Select a Return Type
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 or Updated Incident on PagerDuty

Description:Emit new event each time an incident is created or updated

Version:0.1.1

Key:pagerduty-new-or-updated-incident

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 constants from "../../common/constants.mjs";
import commonWebhook from "../common-webhook.mjs";

export default {
  ...commonWebhook,
  type: "source",
  key: "pagerduty-new-or-updated-incident",
  name: "New or Updated Incident",
  version: "0.1.1",
  description: "Emit new event each time an incident is created or updated",
  methods: {
    ...commonWebhook.methods,
    getMetadata({
      id, occurred_at, data,
    }) {
      return {
        id,
        summary: `Incident ${data.incident?.id || data.id} has been created or updated`,
        ts: Date.parse(occurred_at),
      };
    },
    getEventTypes() {
      return constants.INCIDENT_EVENT_TYPES;
    },
    getHookName() {
      return "New or Updated Incident";
    },
  },
};

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.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Service ID	`serviceId`	`string`	Select a value from the drop down menu.
Events	`webhookEvent`	`string[]`	Select a value from the drop down menu:`incident.acknowledgedincident.annotatedincident.delegatedincident.escalatedincident.reassignedincident.reopenedincident.resolvedincident.status_update_publishedincident.triggeredincident.unacknowledgedincident.responder.addedincident.responder.repliedincident.priority_updatedservice.createdservice.deletedservice.updated`

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#

List Records on Data Stores

Description:List all records in your [Pipedream Data Store](https://pipedream.com/data-stores/).

Version:0.0.3

Key:data_stores-list-records

View on GitHub

Data Stores Overview#

Data Stores are a key-value store that allow you to persist state and share data across workflows. You can perform CRUD operations, enabling dynamic data management within your serverless architecture. Use it to save results from API calls, user inputs, or interim data; then read, update, or enrich this data in subsequent steps or workflows. Data Stores simplify stateful logic and cross-workflow communication, making them ideal for tracking process statuses, aggregating metrics, or serving as a simple configuration store.

Action Code#

/* eslint-disable newline-per-chained-call */
import app from "../../data_stores.app.mjs";
import options from "../../common/options.mjs";

export default {
  key: "data_stores-list-records",
  name: "List Records",
  description: "List all records in your [Pipedream Data Store](https://pipedream.com/data-stores/).",
  version: "0.0.3",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    keys: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Select one or multiple keys to retrieve their records.",
      type: "string[]",
    },
    returnType: {
      label: "Return Type",
      description: "Specify the preferred data structure to return.",
      type: "string",
      options: options.LIST_ALL_RECORDS,
      default: "object",
    },
  },
  async run ({ $ }) {
    let keys = await this.dataStore.keys();
    if (this.keys.length > 0) {
      keys = keys.filter((key) => this.keys.includes(key));
    }
    const promises = [];
    for (const key of keys) {
      promises.push(new Promise((resolve, reject) => {
        this.dataStore.get(key).then((value) => {
          resolve({
            key,
            value,
          });
        }).catch((err) => {
          reject(err);
        });
      }));
    }

    const records = await Promise.all(promises);
    if (keys.length > 0) {
      $.export("$summary", `Found ${keys.length} record(s).`);
    } else {
      $.export("$summary", "No record found.");
    }

    switch (this.returnType) {
    case "object": {
      return records.reduce((acc, record) => {
        acc[record.key] = record.value;
        return acc;
      }, {});
    }
    case "array": {
      return records;
    }
    default:
      throw new Error(`Unknown return type: ${this.returnType}`);
    }
  },
};

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	`keys`	`string[]`	Select a value from the drop down menu.
Return Type	`returnType`	`string`	Select a value from the drop down menu:`{ "label": "Return records as a single object", "value": "object" }`{ "label": "Return records as an array with `key` and `value` properties", "value": "array" }