Search Issues and Pull Requests with GitHub API on New Send Created from Sendoso API

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

Trigger workflow on

New Send Created from the Sendoso API

Next, do this

Search Issues and Pull Requests 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 Created trigger
1. Connect your Sendoso account
2. Configure Polling interval
Configure the Search Issues and Pull Requests action
1. Connect your GitHub account
2. Configure infoBox
3. Configure Query
4. Configure Maximum Results
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 Created on Sendoso

Description:Emit new event when a new send is created. [See docs here](https://sendoso.docs.apiary.io/#reference/send-management/get-all-sent-giftsitems/get-sent-gifts)

Version:0.0.1

Key:sendoso-new-send

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 common from "../common/base.mjs";

export default {
  ...common,
  type: "source",
  name: "New Send Created",
  key: "sendoso-new-send",
  description: "Emit new event when a new send is created. [See docs here](https://sendoso.docs.apiary.io/#reference/send-management/get-all-sent-giftsitems/get-sent-gifts)",
  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,
      },
    },
  },
  methods: {
    ...common.methods,
    getDataToEmit({
      id, touch_name,
    }) {
      return {
        id: id,
        summary: this.getSummary(touch_name, id),
        ts: new Date().getTime(),
      };
    },
    getFieldId() {
      return "id";
    },
    getSummary(name, id) {
      return `New send created: ${name} (${id})`;
    },
    async proccessEvent() {
      const lastId = this._getLastId();
      const data = await this.sendoso.getSentGifts();

      const list = data.filter((item) => (item.id > lastId));

      list.reverse();
      this.emitEvent(list);
    },
    async startRun() {
      const data = await this.sendoso.getSentGifts();
      if (data.length > 20) data.length = 20;
      data.reverse();
      this.emitEvent(data);
    },
  },
};

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

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#

Search Issues and Pull Requests on GitHub

Description:Find issues and pull requests by state and keyword. [See the documentation](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests)

Version:0.2.5

Key:github-search-issues-and-pull-requests

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";

export default {
  key: "github-search-issues-and-pull-requests",
  name: "Search Issues and Pull Requests",
  description: "Find issues and pull requests by state and keyword. [See the documentation](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests)",
  version: "0.2.5",
  type: "action",
  props: {
    github,
    infoBox: {
      type: "alert",
      alertType: "info",
      content: `Example query: \`bug report in:title type:issue repo:octocat/Hello-World\`
      
This will return issues in the repository [octocat/Hello-World](https://github.com/octocat/Hello-World) with the title including the words "bug report".`,
    },
    query: {
      label: "Query",
      description: "The query contains one or more search keywords and qualifiers. [See the documentation](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests) for more information and examples",
      type: "string",
      default: "repo:pipedreamhq/pipedream is:pr is:open sort:updated-desc",
    },
    maxResults: {
      label: "Maximum Results",
      description: "The maximum amount of items to retrieve",
      type: "integer",
      default: 5,
    },
  },
  async run({ $ }) {
    const response = await this.github.searchIssueAndPullRequests({
      query: this.query,
      maxResults: this.maxResults,
    });
    $.export("$summary", `Successfully fetched ${response.length} items`);
    return response;
  },
};

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.
Query	`query`	`string`	The query contains one or more search keywords and qualifiers. See the documentation for more information and examples
Maximum Results	`maxResults`	`integer`	The maximum amount of items to retrieve

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:

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

Search Issues and Pull Requests with GitHub API on New Send Created from Sendoso API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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