Get Reviewers with GitHub API on New Send Status Updated from Sendoso API

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

Trigger workflow on

New Send Status Updated from the Sendoso 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 Sendoso 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 Send Status Updated trigger
1. Connect your Sendoso account
2. Configure Polling interval
3. Select a Tracking Id
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 Send Status Updated on Sendoso

Description:Emit new event when a send status is updated. [See docs here](https://sendoso.docs.apiary.io/#reference/send-management/send-tracking/fetch-the-status-of-a-send)

Version:0.0.1

Key:sendoso-send-status-updated

View on GitHub

Sendoso Overview#

Sendoso is a sending platform that enables companies to engage with customers through direct mail, eGifts, and other physical deliveries. Utilizing the Sendoso API via Pipedream allows for the automation of these outreach efforts, seamlessly integrating with CRM systems, marketing automation, or customer support tools. By leveraging workflows and events, you can trigger Sendoso actions based on user behavior, sales milestones, or support tickets, enhancing the physical impact of your digital engagements.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import common from "../common/base.mjs";

export default {
  ...common,
  type: "source",
  name: "New Send Status Updated",
  key: "sendoso-send-status-updated",
  description: "Emit new event when a send status is updated. [See docs here](https://sendoso.docs.apiary.io/#reference/send-management/send-tracking/fetch-the-status-of-a-send)",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Sendoso API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    trackingId: {
      propDefinition: [
        common.props.sendoso,
        "trackingId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getFunc() {
      return this.sendoso.getSentGifts;
    },
    getDataToEmit({
      date_and_time, status,
    }) {
      return {
        id: date_and_time,
        summary: this.getSummary(status),
        ts: new Date().getTime(date_and_time),
      };
    },
    getFieldId() {
      return "date_and_time";
    },
    getSummary(status) {
      return `Send status updated to ${status}`;
    },
    async prepareData() {
      const { trackingId } = this;
      const { activities } = await this.sendoso.getSendStatus({
        trackingId,
      });

      return activities[0].map((activity) => ({
        ...activity.activity,
      }));
    },
    async proccessEvent() {
      const lastTime = this._getLastId();
      const activities = await this.prepareData();
      const list = activities.filter((item) => moment(item.date_and_time).isAfter(lastTime));

      await this.emitEvent(list);
    },
    async startRun() {
      const activities = await this.prepareData();
      if (activities.length > 20) activities.length = 20;
      await this.emitEvent(activities);
    },
  },
};

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
Sendoso	`sendoso`	`app`	This component uses the Sendoso app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Sendoso API on this schedule
Tracking Id	`trackingId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

publicwriteupdate

About Sendoso#

Sending platform

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 Send Status Updated from Sendoso API

Pipedream makes it easy to connect APIs for GitHub, Sendoso 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