Execute API Function with AppDrag API on New Commit from GitHub API

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

Trigger workflow on

New Commit from the GitHub API

Next, do this

Execute API Function with the AppDrag 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 AppDrag 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 Execute API Function action
1. Connect your AppDrag account
2. Configure Function Name Path
3. Select a HTTP Method
4. Optional- Configure Data
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.9

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.9",
  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#

Execute API Function on AppDrag

Description:Executes an API function from a cloud backend. [See the documentation](https://support.appdrag.com/doc/Interacting-with-my-API-Functions)

Version:0.0.1

Key:appdrag-execute-api-function

View on GitHub

AppDrag Overview#

The AppDrag API lets you manage cloud functions, databases, and mail sending features within your AppDrag projects. With Pipedream, you can harness these capabilities to automate workflows such as syncing data between different platforms, processing form submissions, or triggering communication sequences. By connecting AppDrag’s API to Pipedream, you gain the ability to create serverless workflows that can respond to various triggers like webhooks, schedules, or even actions from other apps.

Action Code#

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

export default {
  key: "appdrag-execute-api-function",
  name: "Execute API Function",
  description: "Executes an API function from a cloud backend. [See the documentation](https://support.appdrag.com/doc/Interacting-with-my-API-Functions)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    path: {
      type: "string",
      label: "Function Name Path",
      description: "The name of the function name path to execute. Eg. `/insert-user`",
    },
    method: {
      type: "string",
      label: "HTTP Method",
      description: "The HTTP method to use when executing the function.",
      options: Object.values(constants.HTTP_METHOD),
    },
    data: {
      type: "object",
      label: "Data",
      description: "The data to pass to the function.",
      optional: true,
    },
  },
  methods: {
    executeApiFunction({
      method, data, ...args
    } = {}) {
      return this.app.makeRequest(
        method === constants.HTTP_METHOD.GET
          ? {
            ...args,
            method,
            params: data,
          }
          : {
            ...args,
            method,
            data,
          },
      );
    },
  },
  async run({ $: step }) {
    const {
      executeApiFunction,
      path,
      method,
      data,
    } = this;

    const response = await executeApiFunction({
      step,
      path,
      method,
      data,
    });

    step.export("$summary", `Executed function \`${path}\` successfully`);

    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
AppDrag	`app`	`app`	This component uses the AppDrag app.
Function Name Path	`path`	`string`	The name of the function name path to execute. Eg. `/insert-user`
HTTP Method	`method`	`string`	Select a value from the drop down menu:`GETPOSTPUTPATCHDELETE`
Data	`data`	`object`	The data to pass to the function.

Action Authentication#

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

You can find your AppID and API Key in the CloudBackend Portal.

Execute API Function with AppDrag API on New Commit from GitHub API

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