Take Screenshot with Playwright API

Pipedream makes it easy to connect APIs for Playwright and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Take Screenshot with the Playwright 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#

Create a workflow to Take Screenshot with the Playwright API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Take Screenshot action
1. Connect your Playwright account
2. Configure URL
3. Configure File Name
4. Select a Color Scheme
5. Configure Full Page
6. Optional- Configure Viewport Width
7. Optional- Configure Viewport Height
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Take Screenshot with Playwright API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Playwright

Try it

Take Screenshot with Playwright API on New Submission from Typeform API

Typeform + Playwright

Try it

Take Screenshot with Playwright API on Custom Events from Zoom API

Zoom + Playwright

Try it

Take Screenshot with Playwright API on New Submission (Instant) from Jotform API

Jotform + Playwright

Try it

Take Screenshot with Playwright API on New Scheduled Tasks from Pipedream API

Pipedream + Playwright

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Take Screenshot on Playwright

Description:Store a new screenshot file on /tmp directory. [See the documentation](https://playwright.dev/docs/screenshots)

Version:0.0.2

Key:playwright-take-screenshot

View on GitHub

Code#

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

export default {
  key: "playwright-take-screenshot",
  name: "Take Screenshot",
  description: "Store a new screenshot file on /tmp directory. [See the documentation](https://playwright.dev/docs/screenshots)",
  version: "0.0.2",
  type: "action",
  props: {
    playwright,
    url: {
      type: "string",
      label: "URL",
      description: "The URL of the page.",
    },
    filename: {
      type: "string",
      label: "File Name",
      description: "The screenshot file name with extension, e.g. `screenshot.png`. it will be stored on `/tmp` directory.",
      default: "screenshot.png",
    },
    colorScheme: {
      type: "string",
      label: "Color Scheme",
      description: "The user color scheme preferences",
      options: [
        "no-preference",
        "light",
        "dark",
      ],
      default: "no-preference",
    },
    fullPage: {
      type: "boolean",
      label: "Full Page",
      description: "When true, takes a screenshot of the full page.",
      default: false,
    },
    viewportWidth: {
      type: "integer",
      label: "Viewport Width",
      description: "The width of viewport. default: `1280`",
      optional: true,
    },
    viewportHeight: {
      type: "integer",
      label: "Viewport Height",
      description: "The height of viewport. default: `720`",
      optional: true,
    },
  },
  async run({ $ }) {
    const browser = await this.playwright.launch();
    const page = await browser.newPage({
      viewport: {
        width: this.viewportWidth || 1280,
        height: this.viewportHeight || 720,
      },
      colorScheme: this.colorScheme,
    });
    await page.goto(this.url);
    const opts = {
      path: `/tmp/${this.filename}`,
      fullPage: this.fullPage,
    };
    await page.screenshot(opts);
    await browser.close();

    $.export("$summary", `Successfully captured screenshot from ${this.url}`);

    return opts;
  },
};

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
Playwright	`playwright`	`app`	This component uses the Playwright app.
URL	`url`	`string`	The URL of the page.
File Name	`filename`	`string`	The screenshot file name with extension, e.g. `screenshot.png`. it will be stored on `/tmp` directory.
Color Scheme	`colorScheme`	`string`	Select a value from the drop down menu:`no-preferencelightdark`
Full Page	`fullPage`	`boolean`	When true, takes a screenshot of the full page.
Viewport Width	`viewportWidth`	`integer`	The width of viewport. default: `1280`
Viewport Height	`viewportHeight`	`integer`	The height of viewport. default: `720`