Create Gist with GitHub API on New Finished Automation Run from Browserhub API

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

Trigger workflow on

New Finished Automation Run from the Browserhub API

Next, do this

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

Select this integration
Configure the New Finished Automation Run trigger
1. Connect your Browserhub account
2. Configure Polling interval
3. Optional- Select a Scraper ID
Configure the Create Gist action
1. Connect your GitHub account
2. Configure Description
3. Configure Files
4. Configure Public
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 Finished Automation Run on Browserhub

Description:Emit new event when an automation run has finished running. [See the documentation](https://developer.browserhub.io/)

Version:0.0.1

Key:browserhub-new-finished-automation-run

View on GitHub

Browserhub Overview#

The Browserhub API offers automation and control over browser sessions, enabling users to create, manipulate, and extract data from web pages programmatically. Integrating Browserhub with Pipedream opens a world of possibilities for automating web interaction workflows, monitoring website changes, scraping data, and testing web applications. Pipedream's serverless platform allows for easy orchestration of API calls and data handling, making it a powerful tool for developers to harness the capabilities of Browserhub in a scalable and efficient manner.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import browserhub from "../../browserhub.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "browserhub-new-finished-automation-run",
  name: "New Finished Automation Run",
  description: "Emit new event when an automation run has finished running. [See the documentation](https://developer.browserhub.io/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    browserhub,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the AskNicely on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    scraperId: {
      propDefinition: [
        browserhub,
        "scraperId",
      ],
      optional: true,
    },
  },
  methods: {
    _getBaseDate() {
      return this.db.get("baseDate");
    },
    _setBaseDate(baseDate = null) {
      this.db.set("baseDate", baseDate);
    },
    async startEvent(maxResults = 0) {
      const baseDate = this._getBaseDate();
      let newBaseDate = null;

      const response = this.browserhub.paginate({
        fn: this.browserhub.listRuns,
        maxResults,
        baseDate,
        params: {
          scraper_id: this.scraperId,
        },
      });

      const responseArray = [];

      for await (const item of response) {
        if (item.status === "successful") responseArray.push(item);
        if (item.status === "running") newBaseDate = item.created_at;
      }

      if (newBaseDate) this._setBaseDate(newBaseDate);
      if (!newBaseDate && responseArray.length) this._setBaseDate(responseArray[0].created_at);

      for (const item of responseArray.reverse()) {
        this.$emit(
          item,
          {
            id: item.id,
            summary: `Successfully finished automation run with ID: ${item.id}`,
            ts: item.created_at,
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
Browserhub	`browserhub`	`app`	This component uses the Browserhub app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the AskNicely on this schedule
Scraper ID	`scraperId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Browserhub#

Easy to use no-code web scraping and data extraction software.

Action#

Create Gist on GitHub

Description:Allows you to add a new gist with one or more files. [See the documentation](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28#create-a-gist)

Version:0.0.7

Key:github-create-gist

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.

Action Code#

import github from "../../github.app.mjs";
import utils from "../../actions/common/utils.mjs";

export default {
  key: "github-create-gist",
  name: "Create Gist",
  description: "Allows you to add a new gist with one or more files. [See the documentation](https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28#create-a-gist)",
  version: "0.0.7",
  type: "action",
  props: {
    github,
    description: {
      label: "Description",
      description: "The description of the gist",
      type: "string",
    },
    files: {
      label: "Files",
      description: "The files that will be added to the gist. The key is the file name and the value is the content of the file. Ex: `{\"file1.txt\": \"content of file 1\", \"file2.txt\": \"content of file 2\"}`",
      type: "object",
    },
    public: {
      label: "Public",
      description: "Indicates whether the gist is public or not",
      type: "boolean",
    },
  },
  async run({ $ }) {
    const res = await this.github.createGist({
      description: this.description,
      files: utils.convertFiles(this.files),
      public: this.public,
    });

    $.export("$summary", `Successfully created gist with ID "${res.id}".`);
    return res;
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Description	`description`	`string`	The description of the gist
Files	`files`	`object`	The files that will be added to the gist. The key is the file name and the value is the content of the file. Ex: `{"file1.txt": "content of file 1", "file2.txt": "content of file 2"}`
Public	`public`	`boolean`	Indicates whether the gist is public or not

Action 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

Create Gist with GitHub API on New Finished Automation Run from Browserhub API

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