Get Reviewers with GitHub API on New CES Rating from Nicereply API

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

Trigger workflow on

New CES Rating from the Nicereply API

Next, do this

Get Reviewers with the GitHub 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 Nicereply trigger and GitHub action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New CES Rating trigger
1. Connect your Nicereply account
2. Configure timer
Configure the Get Reviewers action
1. Connect your GitHub account
2. Select a Repository
3. Select a PR or Commit
4. Optional- Select one or more Review States
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 CES Rating on Nicereply

Description:Emit new event on each new CES rating.

Version:0.0.2

Key:nicereply-new-ces-rating

View on GitHub

Nicereply Overview#

The Nicereply API enables the integration of customer satisfaction data into various business workflows. With its API, you can automate the collection of customer feedback, analyze customer sentiment, track agent performance, and generate actionable insights. Leveraging Pipedream’s capabilities, you can create powerful automations that respond to Nicereply events, synchronize data across platforms, and trigger actions in other applications, enriching CRM data or streamlining support workflows.

Trigger Code#

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

export default {
  ...common,
  name: "New CES Rating",
  version: "0.0.2",
  key: "nicereply-new-ces-rating",
  description: "Emit new event on each new CES rating.",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    emitEvent(data) {
      this.$emit(data, {
        id: data.id,
        summary: `New CES rating with id ${data.id}`,
        ts: Date.parse(data.created_at),
      });
    },
    getRatings() {
      return this.nicereply.getCESRatings;
    },
  },
};

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
Nicereply	`nicereply`	`app`	This component uses the Nicereply app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

To get your private API key go to your Nicereply account > Settings > API > and copy the private key.

About Nicereply#

Nicereply helps our customers tell us whether they’re getting what they need. This creates opportunities to respond to specific feedback in the short-term while developing longer-term solutions in our approach.

Action#

Get Reviewers on GitHub

Description:Get reviewers for a PR ([see documentation](https://docs.github.com/en/rest/pulls/reviews#list-reviews-for-a-pull-request)) or Commit SHA ([see documentation](https://docs.github.com/en/rest/commits/commits#list-pull-requests-associated-with-a-commit)).

Version:0.1.0

Key:github-get-reviewers

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Action Code#

import github from "../../github.app.mjs";
import asyncProps from "../common/asyncProps.mjs";
import constants from "../common/constants.mjs";

export default {
  key: "github-get-reviewers",
  name: "Get Reviewers",
  description: "Get reviewers for a PR ([see documentation](https://docs.github.com/en/rest/pulls/reviews#list-reviews-for-a-pull-request)) or Commit SHA ([see documentation](https://docs.github.com/en/rest/commits/commits#list-pull-requests-associated-with-a-commit)).",
  version: "0.1.0",
  type: "action",
  props: {
    github,
    repoFullname: {
      propDefinition: [
        github,
        "repoFullname",
      ],
    },
    prOrCommit: {
      type: "string",
      label: "PR or Commit",
      description: "Whether to get reviewers for a [pull request](https://docs.github.com/en/rest/pulls/reviews#list-reviews-for-a-pull-request) or a [commit SHA](https://docs.github.com/en/rest/commits/commits#list-pull-requests-associated-with-a-commit).",
      options: [
        "Pull Request",
        "Commit SHA",
      ],
      reloadProps: true,
    },
    reviewStates: {
      type: "string[]",
      label: "Review States",
      description: "Filter by these review states",
      options: constants.PULL_REQUEST_STATES,
      optional: true,
    },
  },
  async additionalProps() {
    return this.prOrCommit === "Pull Request"
      ? {
        pullNumber: asyncProps.pullNumber,
      }
      : {
        commitSha: {
          type: "string",
          label: "Commit SHA",
          description: "A commit SHA to get reviewers for",
        },
      };
  },
  methods: {
    getReviewers(reviews) {
      const reviewers = reviews
        .filter((review) => {
          if (this.reviewStates?.length) {
            return this.reviewStates.includes(review.state); // user-defined states
          }
          return true; // default states: all
        })
        .map((review) => review.user.login);
      return this.uniqueReviewers(reviewers);
    },
    uniqueReviewers(reviewers) {
      return [
        ...new Set(reviewers),
      ];
    },
  },
  async run({ $ }) {
    let pullNumber = this.pullNumber;

    if (this.commitSha) {
      const pr = await this.github.getPullRequestForCommit({
        repoFullname: this.repoFullname,
        sha: this.commitSha,
      });

      if (!pr?.number) {
        $.export("$summary", "No PR associated with this commit");
        return;
      }

      pullNumber = pr.number;
    }

    const reviews = await this.github.getReviewsForPullRequest({
      repoFullname: this.repoFullname,
      pullNumber,
    });

    const reviewers = this.getReviewers(reviews);

    $.export("$summary", "Successfully retrieved reviewers");

    return reviewers;
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
PR or Commit	`prOrCommit`	`string`	Select a value from the drop down menu:`Pull RequestCommit SHA`
Review States	`reviewStates`	`string[]`	Select a value from the drop down menu:`APPROVEDCHANGES_REQUESTEDCOMMENTEDDISMISSEDPENDING`

Action Authentication#

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

Get Reviewers with GitHub API on New CES Rating from Nicereply API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular