Get Reviewers with GitHub API on New Supporter Added from Buy Me a Coffee API

Pipedream makes it easy to connect APIs for GitHub, Buy Me a Coffee and 2,200+ other apps remarkably fast.

Trigger workflow on

New Supporter Added from the Buy Me a Coffee 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 Buy Me a Coffee 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 Supporter Added trigger
1. Connect your Buy Me a Coffee 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 Supporter Added on Buy Me a Coffee

Description:Emit new events when a new supporter was added. [See the docs](https://developers.buymeacoffee.com/#/apireference?id=onetime-supporters-v1supporters)

Version:0.0.3

Key:buy_me_a_coffee-new-supporter-added

View on GitHub

Buy Me a Coffee Overview#

The Buy Me a Coffee API allows creators to interact programmatically with their Buy Me a Coffee account. Through Pipedream, you can automate actions such as thanking supporters, tracking donations, and posting updates. By integrating with other apps, you can extend functionalities, streamline your supporter engagement, and analyze your growth.

Trigger Code#

import { defineSource } from "@pipedream/types";
import common from "../common/common.mjs";
export default defineSource({
    ...common,
    key: "buy_me_a_coffee-new-supporter-added",
    name: "New Supporter Added",
    description: "Emit new events when a new supporter was added. [See the docs](https://developers.buymeacoffee.com/#/apireference?id=onetime-supporters-v1supporters)",
    version: "0.0.3",
    type: "source",
    dedupe: "unique",
    methods: {
        ...common.methods,
        getResourceFn() {
            return this.app.getSupporters;
        },
        compareFn(item) {
            return this.getLastCreatedTime() < new Date(item.support_created_on).getTime();
        },
        getSummary(item) {
            return `New supporter ${item.payer_name} note(${item.support_note})`;
        },
        getTimeKey() {
            return "support_created_on";
        },
        getIdKey() {
            return "support_id";
        },
    },
});

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

Trigger Authentication#

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

To connect your Buy Me a Coffee account with Pipedream, first sign in to your Buy Me a Coffee developer dashboard.

Generate your API token by clicking on the "generate my token" button
Provide a name for your token and click "generate"
Your token will be displayed -- copy that and paste it below

About Buy Me a Coffee#

A supporter is worth a thousand followers. Accept donations. Start a membership. Sell anything you like. It’s easier than you think.

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 Supporter Added from Buy Me a Coffee API

Pipedream makes it easy to connect APIs for GitHub, Buy Me a Coffee and 2,200+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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