Get Website Screenshot with GetScreenshot API on New Package Version from npm API

Pipedream makes it easy to connect APIs for GetScreenshot, npm and 2,900+ other apps remarkably fast.

Trigger workflow on

New Package Version from the npm API

Next, do this

Get Website Screenshot with the GetScreenshot 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 npm trigger and GetScreenshot action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Package Version trigger
1. Connect your npm account
2. Configure timer
3. Configure Package
Configure the Get Website Screenshot action
1. Connect your GetScreenshot account
2. Configure Website URL
3. Optional- Select a Image Format
4. Optional- Configure Email Address
5. Optional- Configure Element
6. Optional- Configure Additional Parameters
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 Package Version on npm

Description:Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)

Version:0.0.1

Key:npm-new-package-version

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../npm.app.mjs";

export default {
  key: "npm-new-package-version",
  name: "New Package Version",
  description: "Emit new event when a new version of an npm package is published. [See the documentation](https://github.com/npm/registry/blob/main/docs/responses/package-metadata.md)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      default: "@pipedream/platform",
    },
  },
  async run() {
    const {
      app,
      packageName,
    } = this;

    const response = await app.getPackageMetadata({
      debug: true,
      packageName,
    });

    const { "dist-tags": { latest: latestVersion } } = response;

    this.$emit(response, {
      id: latestVersion,
      summary: `New Package Version ${latestVersion}`,
      ts: Date.parse(response.modified),
    });
  },
};

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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Get Website Screenshot on GetScreenshot

Description:Capture a screenshot from a live website. [See the documentation](https://docs.rasterwise.com/docs/getscreenshot/api-reference-0/)

Version:0.0.3

Key:getscreenshot-get-website-screenshot

View on GitHub

GetScreenshot Overview#

The GetScreenshot API is a potent tool for capturing webpage snapshots programmatically. Integrating GetScreenshot with Pipedream opens up a plethora of automation possibilities, from monitoring website updates in real-time to generating visual reports for clients. With Pipedream, you can create workflows that trigger screenshots based on specific events, store or send them to stakeholders, and even analyze webpage changes without manual intervention.

Action Code#

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

export default {
  key: "getscreenshot-get-website-screenshot",
  name: "Get Website Screenshot",
  description: "Capture a screenshot from a live website. [See the documentation](https://docs.rasterwise.com/docs/getscreenshot/api-reference-0/)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    getscreenshot,
    url: {
      type: "string",
      label: "Website URL",
      description: "URL of the website / page you want to screenshot. Should start with `http://` or `https://`",
    },
    format: {
      type: "string",
      label: "Image Format",
      description: "The file type/format in which you want to get your capture. If `pdf` is selected, an A4 PDF of the passed website will be generated, rendered the same as if you were printing it from your browser.",
      options: [
        "png",
        "jpeg",
        "pdf",
      ],
      default: "png",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email Address",
      description: "If specified, a formatted email will be sent to this email address, including the captured image and details of the capture.",
      optional: true,
    },
    element: {
      type: "string",
      label: "Element",
      description: "If you need to target specific DOM elements instead of taking dimension-based screenshots, you can specify an element DOM selector, e.g. `#colordiv` to target a div with the id \"colordiv\".",
      optional: true,
    },
    additionalParams: {
      type: "object",
      label: "Additional Parameters",
      description: "Additional parameters (key/value pairs) to send in this request. [See the documentation](https://docs.rasterwise.com/docs/getscreenshot/api-reference-0/) for all available parameters.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      getscreenshot, format, additionalParams, ...params
    } = this;
    const response = await getscreenshot.getScreenshot({
      $,
      params: {
        ...params,
        ...(format === "pdf"
          ? {
            pdf: true,
          }
          : {
            format,
          }),
        ...additionalParams,
      },
    });
    $.export("$summary", `Successfully captured screenshot of "${this.url}"`);
    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
GetScreenshot	`getscreenshot`	`app`	This component uses the GetScreenshot app.
Website URL	`url`	`string`	URL of the website / page you want to screenshot. Should start with `http://` or `https://`
Image Format	`format`	`string`	Select a value from the drop down menu:`pngjpegpdf`
Email Address	`email`	`string`	If specified, a formatted email will be sent to this email address, including the captured image and details of the capture.
Element	`element`	`string`	If you need to target specific DOM elements instead of taking dimension-based screenshots, you can specify an element DOM selector, e.g. `#colordiv` to target a div with the id "colordiv".
Additional Parameters	`additionalParams`	`object`	Additional parameters (key/value pairs) to send in this request. See the documentation for all available parameters.