Generate Match Report with Interzoid API on New Commit from GitHub API

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

Trigger workflow on

New Commit from the GitHub API

Next, do this

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

Select this integration
Configure the New Commit trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
4. Select a Branch
Configure the Generate Match Report action
1. Connect your Interzoid account
2. Select a Matching Algorithm Type
3. Select a Database Connection Type
4. Configure Connection String
5. Configure Table Name
6. Configure Match Column Name
7. Optional- Configure Reference
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 Commit on GitHub

Description:Emit new event when commits are pushed to a branch

Version:1.0.8

Key:github-new-commit

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.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-commit",
  name: "New Commit",
  description: "Emit new event when commits are pushed to a branch",
  version: "1.0.8",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** one event is emitted for each individual commit, even if they are received at the same time.",
    },
    ...common.props,
    branch: {
      propDefinition: [
        common.props.github,
        "branch",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getLastTimestamp() {
      return this.db.get("lastTimestamp") ?? Date.now();
    },
    _setLastTimestamp(value) {
      this.db.set("lastTimestamp", value);
    },
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "push",
      ];
    },
    getSummary(item) {
      return `New commit: ${item.commit?.message ?? item.message}`;
    },
    async onWebhookTrigger(event) {
      const {
        body, headers,
      } = event;
      if (body?.ref?.split?.("refs/heads/").pop() === this.branch.split("/").pop()) {
        body.commits.forEach((commit) => {
          const { id } = commit;
          this.emitEvent({
            id,
            headers,
            item: commit,
          });
        });
      }
    },
    async onTimerTrigger() {
      const { repoFullname } = this;
      const timestamp = this._getLastTimestamp();
      const since = new Date(timestamp).toISOString()
        .slice(0, -5) + "Z";
      const sha = this.branch.split("/").pop();
      const items = await this.github.getCommits({
        repoFullname,
        sha,
        since,
      });

      const savedItems = this._getSavedItems();
      const shouldEmit = this.shouldEmit();

      items
        .filter(({ sha }) => !savedItems.includes(sha))
        .sort((a, b) => {
          const dateA = new Date(a.commit.author.date);
          const dateB = new Date(b.commit.author.date);
          return dateA - dateB;
        })
        .forEach((item) => {
          const id = item.sha;
          if (shouldEmit) {
            this.emitEvent({
              id,
              item,
            });
          }
          savedItems.push(id);
        });

      this._setSavedItems(savedItems);
      this._setLastTimestamp(Date.now());
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#push";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#list-commits";
    },
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Branch	`branch`	`string`	Select a value from the drop down menu.

Trigger 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

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Generate Match Report on Interzoid

Description:Generate a Match Report using a dataset table or file (CSV/TSV/Excel). [See the documentation](https://connect.interzoid.com/data-matching-workflow)

Version:0.0.1

Key:interzoid-generate-match-report

View on GitHub

Interzoid Overview#

The Interzoid API offers a plethora of data-driven APIs that enable you to enrich, standardize, and deduplicate data across various fields such as demographics, financials, and text. With these capabilities, you can enhance data quality, drive better analytics, and create more intelligent workflows and applications. In Pipedream, you can integrate these APIs into serverless workflows, triggering actions based on various events, manipulating and routing data to other apps, services, or data stores with ease.

Action Code#

import interzoid from "../../interzoid.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "interzoid-generate-match-report",
  name: "Generate Match Report",
  description: "Generate a Match Report using a dataset table or file (CSV/TSV/Excel). [See the documentation](https://connect.interzoid.com/data-matching-workflow)",
  version: "0.0.1",
  type: "action",
  props: {
    interzoid,
    category: {
      type: "string",
      label: "Matching Algorithm Type",
      description: "This category type indicates which set of Machine Learning and matching algorithms to make use of based on type of data content",
      options: constants.CATEGORY_OPTIONS,
    },
    source: {
      type: "string",
      label: "Database Connection Type",
      description: "Source of data, such as 'CSV', 'Snowflake', 'Postgres', etc.",
      options: constants.SOURCE_OPTIONS,
    },
    connection: {
      type: "string",
      label: "Connection String",
      description: "Connection string to access database, or in the case of a CSV or TSV file, use the full URL of the location of the file.",
    },
    table: {
      type: "string",
      label: "Table Name",
      description: "Table name to access the source data. Use \"CSV\" or \"TSV\" for delimited text files.",
    },
    column: {
      type: "string",
      label: "Match Column Name",
      description: "Column name within the table to access the source data. This is a number for CSV or TSV files, starting with number 1 from the left side of the file.",
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "An additional column from the source table to display in the output results, such as a primary key.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.interzoid.generateMatchReport({
      $,
      params: {
        category: this.category,
        source: this.source,
        connection: this.connection,
        table: this.table,
        column: this.column,
        reference: this.reference,
      },
    });

    $.export("$summary", "Successfully generated match report");

    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
Interzoid	`interzoid`	`app`	This component uses the Interzoid app.
Matching Algorithm Type	`category`	`string`	Select a value from the drop down menu:`{ "label": "Company and Organization Names", "value": "company" }{ "label": "Individual Names", "value": "individual" }{ "label": "Street Addresses", "value": "address" }`
Database Connection Type	`source`	`string`	Select a value from the drop down menu:`AWS RDS/AuroraSnowflakeAzure SQLGoogle Cloud SQLDatabricksPostgreSQLMySQLMariaDBParquetCSVTSVExcel`
Connection String	`connection`	`string`	Connection string to access database, or in the case of a CSV or TSV file, use the full URL of the location of the file.
Table Name	`table`	`string`	Table name to access the source data. Use "CSV" or "TSV" for delimited text files.
Match Column Name	`column`	`string`	Column name within the table to access the source data. This is a number for CSV or TSV files, starting with number 1 from the left side of the file.
Reference	`reference`	`string`	An additional column from the source table to display in the output results, such as a primary key.

Generate Match Report with Interzoid API on New Commit from GitHub API

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