Query IP address with IP2Location API on New Commit Comment from GitHub API

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

Trigger workflow on

New Commit Comment from the GitHub API

Next, do this

Query IP address with the IP2Location 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 IP2Location 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 Query IP address action
1. Connect your IP2Location account
2. Configure IP Address
3. Select a Package
4. Optional- Select a Response Format
5. Optional- Select a Translation Language
6. Optional- Select one or more Addon
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.10

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.10",
  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:

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin: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#

Query IP address on IP2Location

Description:Query IP address using IP2Location API. [See the docs here](https://www.ip2location.com/web-service/ip2location) for how to use this API.

Version:0.0.2

Key:ip2location-query-ip-info

View on GitHub

IP2Location Overview#

The IP2Location API enables you to uncover valuable information about an IP address. With it, you can pinpoint a user's geographic location, such as country, region, city, and even latitude and longitude coordinates. This data is essential for various tasks like localizing content, analyzing traffic, or enhancing security by detecting potentially malicious activity. Using Pipedream, you can automate actions based on IP location data, integrating it with hundreds of other services without writing any code.

Action Code#

import ip2locationApp from "../../ip2location.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  name: "Query IP address",
  description: "Query IP address using IP2Location API. [See the docs here](https://www.ip2location.com/web-service/ip2location) for how to use this API.",
  key: "ip2location-query-ip-info",
  version: "0.0.2",
  type: "action",
  props: {
    ip2locationApp,
    ipAddress: {
      type: "string",
      label: "IP Address",
      description: "IP address (IPv4 or IPv6) for reverse IP location lookup purposes.",
    },
    wsPackage: {
      type: "string",
      label: "Package",
      options: constants.PACKAGE_OPTIONS,
      description: "Web service package of different granularity of return information. Please refer to the pricing table in our [documentation](https://www.ip2location.com/web-service/ip2location) for the information returned.",
    },
    format: {
      type: "string",
      label: "Response Format",
      options: constants.FORMAT_OPTIONS,
      description: "Format of the response message. Available values are `json` or `xml`. If unspecified, json format will be used for the response message.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Translation Language",
      options: constants.LANGUAGE_OPTIONS,
      description: "Translation information. The translation is only applicable for continent, country, region and city name for the **addon** package.",
      optional: true,
    },
    addon: {
      type: "string[]",
      label: "Addon",
      options: constants.ADDON_OPTIONS,
      description: "Extra information in addition to the above-selected package. Please refer to the pricing table in our [documentation](https://www.ip2location.com/web-service/ip2location) for the information returned. You can query for multiple addons by putting a comma at between of them, for example `continent,country`. Valid value: `continent`, `country`, `region`, `city`, `geotargeting`, `country_groupings`, `time_zone_info`",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      ipAddress,
      format,
      language,
      wsPackage,
      addon,
    } = this;
    var addon_formatted = "";
    for (let i = 0; i < addon.length; i++) {
      addon_formatted += addon[i] + ",";
    }
    const response =
      await this.ip2locationApp.queryIPInfo({
        $,
        params: {
          format: format ?? "json",
          language: language ?? "en",
          ip: ipAddress,
          package: wsPackage,
          addon: addon_formatted ?? "",
        },
      });
    $.export("$summary", "Successfully queried IP address information with IP2Location API.");
    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
IP2Location	`ip2locationApp`	`app`	This component uses the IP2Location app.
IP Address	`ipAddress`	`string`	IP address (IPv4 or IPv6) for reverse IP location lookup purposes.
Package	`wsPackage`	`string`	Select a value from the drop down menu:`WS1WS2WS3WS4WS5WS6WS7WS8WS9WS10WS11WS12WS13WS14WS15WS16WS17WS18WS19WS20WS21WS22WS23WS24WS25`
Response Format	`format`	`string`	Select a value from the drop down menu:`jsonxml`
Translation Language	`language`	`string`	Select a value from the drop down menu:`arcsdadeenesetfifrgaitjakomsnlptrusvtrvizh-cnzh-tw`
Addon	`addon`	`string[]`	Select a value from the drop down menu:`continentcountryregioncitygeotargetingcountry_groupingstime_zone_info`

Query IP address with IP2Location API on New Commit Comment from GitHub API

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