Extract Data From URL with Automatic Data Extraction API on New Branch Created from GitHub API

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

Trigger workflow on

New Branch Created from the GitHub API

Next, do this

Extract Data From URL with the Automatic Data Extraction 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 Automatic Data Extraction action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Branch Created trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Extract Data From URL action
1. Connect your Automatic Data Extraction account
2. Configure URL
3. Select a Page Type
4. Optional- Configure Meta
5. Optional- Configure Article Body Raw
6. Optional- Configure Full HTML
7. Optional- Configure Custom HTML
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 Branch Created on GitHub

Description:Emit new event when a branch is created.

Version:1.0.10

Key:github-new-branch

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-branch",
  name: "New Branch Created",
  description: "Emit new event when a branch is created.",
  version: "1.0.10",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "create",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.ref_type === "branch";
    },
    getId(item) {
      return item.ref ?? item.name;
    },
    getSummary(item) {
      return `New branch: ${this.getId(item)}`;
    },
    getPollingData(args) {
      return this.github.getBranches(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#create";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#list-branches";
    },
  },
};

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#

Extract Data From URL on Automatic Data Extraction

Description:Extract data from a specified URL [See the docs here](https://docs.zyte.com/automatic-extraction-integrations.html#node-js)

Version:0.0.1

Key:automatic_data_extraction-extract-data-from-url

View on GitHub

Automatic Data Extraction Overview#

The Automatic Data Extraction API by Zyte specializes in extracting structured data from web pages. When incorporated into Pipedream workflows, this API allows you to automate the process of gathering web data, which can feed into various tasks such as market research, price monitoring, or even lead generation. By triggering workflows with new data inputs, processing and storing the extracted data, and connecting to other apps, Pipedream amplifies the API's utility.

Action Code#

import automaticDataExtraction from "../../automatic_data_extraction.app.mjs";
import { PAGE_TYPES } from "../../common/constants.mjs";
import { clearObj } from "../../common/utils.mjs";

export default {
  key: "automatic_data_extraction-extract-data-from-url",
  name: "Extract Data From URL",
  version: "0.0.1",
  description: "Extract data from a specified URL [See the docs here](https://docs.zyte.com/automatic-extraction-integrations.html#node-js)",
  type: "action",
  props: {
    automaticDataExtraction,
    url: {
      type: "string",
      label: "URL",
      description: "URL of web page to extract from. Must be a valid `http://` or `https:// URL`.",
    },
    pageType: {
      type: "string",
      label: "Page Type",
      description: "Type of extraction to perform.",
      options: PAGE_TYPES,
    },
    meta: {
      type: "string",
      label: "Meta",
      description: "User UTF-8 string, which will be passed through the extraction pipeline and returned in the query result. Max size 4 Kb.",
      optional: true,
    },
    articleBodyRaw: {
      type: "boolean",
      label: "Article Body Raw",
      description: "Whether or not to include article HTML in article extractions. True by default. Setting this to false can reduce response size significantly if HTML is not required.",
      optional: true,
    },
    fullHtml: {
      type: "boolean",
      label: "Full HTML",
      description: "Include the full, raw HTML of the target web page in the query result. This is a premium feature that is disabled by default. [Open a support ticket](https://support.zyte.com/support/tickets/new) if you wish to have it enabled for your account.",
      optional: true,
    },
    customHtml: {
      type: "string",
      label: "Custom HTML",
      description: "HTML source to be scraped. Extraction will be done from the provided HTML with additional resources (images, CSS, etc.) downloaded from the provided url. JavaScript processing will be disabled. The String should be UTF-8 encoded. The maximum length is 2,000,000 characters, longer requests will be rejected.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      automaticDataExtraction,
      ...data
    } = this;

    const response = await automaticDataExtraction.extractData({
      $,
      data: JSON.stringify([
        clearObj(data),
      ]),
    });

    $.export("$summary", "The data was successfully extracted!");
    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
Automatic Data Extraction	`automaticDataExtraction`	`app`	This component uses the Automatic Data Extraction app.
URL	`url`	`string`	URL of web page to extract from. Must be a valid `http://` or `https:// URL`.
Page Type	`pageType`	`string`	Select a value from the drop down menu:`articlearticleListcommentsforumPostsjobPostingproductproductListrealEstatereviewsvehicle`
Meta	`meta`	`string`	User UTF-8 string, which will be passed through the extraction pipeline and returned in the query result. Max size 4 Kb.
Article Body Raw	`articleBodyRaw`	`boolean`	Whether or not to include article HTML in article extractions. True by default. Setting this to false can reduce response size significantly if HTML is not required.
Full HTML	`fullHtml`	`boolean`	Include the full, raw HTML of the target web page in the query result. This is a premium feature that is disabled by default. Open a support ticket if you wish to have it enabled for your account.
Custom HTML	`customHtml`	`string`	HTML source to be scraped. Extraction will be done from the provided HTML with additional resources (images, CSS, etc.) downloaded from the provided url. JavaScript processing will be disabled. The String should be UTF-8 encoded. The maximum length is 2,000,000 characters, longer requests will be rejected.

Action Authentication#

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

To retrieve your API Key,

Navigate to your Automatic Data Extraction API account at Zyte and sign in
Go to “Automatic Extraction” > “API Access”

About Automatic Data Extraction#

Instantly access web data with our patented AI-powered automated extraction API.

More Ways to Connect Automatic Data Extraction + GitHub#

Other Popular Integrations#

Extract Data From URL with Automatic Data Extraction API on New Card in Column (Classic Projects) from GitHub API

GitHub + Automatic Data Extraction

Extract Data From URL with Automatic Data Extraction API on New Branch Created from GitHub API

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