Get Performance Report with GTmetrix API on New Commit Comment from GitHub API

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

Trigger workflow on

New Commit Comment from the GitHub API

Next, do this

Get Performance Report with the GTmetrix 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 GTmetrix 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 Comment trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
Configure the Get Performance Report action
1. Connect your GTmetrix account
2. Select a Page
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 Comment on GitHub

Description:Emit new event when a commit comment is created

Version:1.0.7

Key:github-new-commit-comment

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-comment",
  name: "New Commit Comment",
  description: "Emit new event when a commit comment is created",
  version: "1.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** commit comments are not the same as pull request comments. [See the GitHub documentation](https://docs.github.com/en/rest/guides/working-with-comments?apiVersion=2022-11-28) for more information.",
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "commit_comment",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.action === "created";
    },
    getWebhookEventItem(body) {
      return body.comment;
    },
    getSummary(item) {
      return `New comment (${item.id})`;
    },
    getPollingData(args) {
      return this.github.getRepositoryLatestCommitComments(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#commit_comment";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/comments?apiVersion=2022-11-28#list-commit-comments-for-a-repository";
    },
  },
};

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.

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#

Get Performance Report on GTmetrix

Description:Fetches the most recent performance report for a particular page from GTmetrix. [See the documentation](https://gtmetrix.com/api/docs/2.0/#api-page-latest-report)

Version:0.0.1

Key:gtmetrix-get-performance-report

View on GitHub

GTmetrix Overview#

The GTmetrix API provides an interface to test the loading speed of your website, offering insights into performance issues and potential optimizations. By integrating this API with Pipedream, you can automate performance monitoring, receive alerts, and combine data with other services for in-depth analysis. For instance, you could trigger a performance report after a site update, log results to a spreadsheet for tracking, or compare your metrics against industry standards.

Action Code#

import gtmetrix from "../../gtmetrix.app.mjs";

export default {
  key: "gtmetrix-get-performance-report",
  name: "Get Performance Report",
  description: "Fetches the most recent performance report for a particular page from GTmetrix. [See the documentation](https://gtmetrix.com/api/docs/2.0/#api-page-latest-report)",
  version: "0.0.1",
  type: "action",
  props: {
    gtmetrix,
    pageId: {
      propDefinition: [
        gtmetrix,
        "pageId",
      ],
    },
  },
  async run({ $ }) {
    const { data: report } = await this.gtmetrix.getLatestReport({
      pageId: this.pageId,
      $,
    });

    if (report?.id) {
      $.export("$summary", `Successfully retrieved report with ID ${report.id}.`);
    }

    return report;
  },
};

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
GTmetrix	`gtmetrix`	`app`	This component uses the GTmetrix app.
Page	`pageId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API Key,

Navigate to your GTmetrix account and sign in
Go to “Account” > “API Usage”

Get Performance Report with GTmetrix API on New Commit Comment from GitHub API

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