Take Animated Screenshot with ScreenshotOne API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Take Animated Screenshot with the ScreenshotOne 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 Animated Screenshot with the ScreenshotOne API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Take Animated Screenshot action
1. Connect your ScreenshotOne account
2. Configure Website URL
3. Configure File name
4. Select a Scenario
5. Configure Viewport Width
6. Configure Viewport Height
7. Select a Format
8. Optional- Configure Scroll Delay
9. Optional- Configure Scroll Duration
10. Optional- Configure Scroll By
11. Optional- Configure Block Cookie Banners
12. Optional- Configure Block Ads
13. Optional- Configure Block Trackers
14. Optional- Configure Delay
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 Animated Screenshot with ScreenshotOne API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ScreenshotOne

Try it

Take Animated Screenshot with ScreenshotOne API on New Submission from Typeform API

Typeform + ScreenshotOne

Try it

Take Animated Screenshot with ScreenshotOne API on Custom Events from Zoom API

Zoom + ScreenshotOne

Try it

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

Jotform + ScreenshotOne

Try it

Take Animated Screenshot with ScreenshotOne API on New Scheduled Tasks from Pipedream API

Pipedream + ScreenshotOne

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 Animated Screenshot on ScreenshotOne

Description:Takes and returns an animated screenshot of the given site with specified options. [See the documentation](https://screenshotone.com/docs/animated-screenshots/)

Version:0.0.2

Key:screenshotone-take-animated-screenshot

View on GitHub

Code#

import app from "../../screenshotone.app.mjs";
import constants from "../common/constants.mjs";

export default {
  key: "screenshotone-take-animated-screenshot",
  name: "Take Animated Screenshot",
  description: "Takes and returns an animated screenshot of the given site with specified options. [See the documentation](https://screenshotone.com/docs/animated-screenshots/)",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    websiteUrl: {
      propDefinition: [
        app,
        "websiteUrl",
      ],
    },
    fileName: {
      propDefinition: [
        app,
        "fileName",
      ],
    },
    scenario: {
      type: "string",
      label: "Scenario",
      description: "The default scenario is to record animation after loading the site without additional animations. [See the documentation](https://screenshotone.com/docs/animated-screenshots/#default-stand-still)",
      options: constants.ANIMATED_SCENARIO_OPTIONS,
    },
    viewportWidth: {
      propDefinition: [
        app,
        "viewportWidth",
      ],
    },
    viewportHeight: {
      propDefinition: [
        app,
        "viewportHeight",
      ],
    },
    format: {
      propDefinition: [
        app,
        "format",
      ],
      options: constants.ANIMATED_FORMAT_OPTIONS,
    },
    scrollDelay: {
      type: "integer",
      label: "Scroll Delay",
      description: "Delay in milliseconds between scrolls. The default value is `500`",
      optional: true,
    },
    scrollDuration: {
      type: "integer",
      label: "Scroll Duration",
      description: "Duration in milliseconds of one scroll. The default value is `1500`",
      optional: true,
    },
    scrollBy: {
      type: "integer",
      label: "Scroll By",
      description: "By how many pixes scroll. The default value is `1000`",
      optional: true,
    },
    blockCookieBanners: {
      propDefinition: [
        app,
        "blockCookieBanners",
      ],
    },
    blockAds: {
      propDefinition: [
        app,
        "blockAds",
      ],
    },
    blockTrackers: {
      propDefinition: [
        app,
        "blockTrackers",
      ],
    },
    delay: {
      propDefinition: [
        app,
        "delay",
      ],
    },
  },
  async run({ $ }) {
    const params = {
      url: this.websiteUrl,
      scenario: this.scenario,
      format: this.format,
      width: this.viewportWidth,
      height: this.viewportHeight,
      block_cookie_banners: this.blockCookieBanners,
      block_ads: this.blockAds,
      block_trackers: this.blockTrackers,
      delay: this.delay,
      scroll_delay: this.scrollDelay,
      scroll_duration: this.scrollDuration,
      scroll_by: this.scrollBy,
    };

    const fileStream = await this.app.takeAnimatedScreenshot({
      $,
      params,
    });

    const filePath = await this.app.writeStream({
      fileStream,
      fileName: `${this.fileName}.${this.format}`,
    });

    $.export("$summary", `Successfully took the animated screenshot from ${this.websiteUrl}`);
    return filePath;
  },
};

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
ScreenshotOne	`app`	`app`	This component uses the ScreenshotOne app.
Website URL	`websiteUrl`	`string`	The URL of the website to take a screenshot of
File name	`fileName`	`string`	The new name of the file to be saved without extension. e.g: `screenshot`
Scenario	`scenario`	`string`	Select a value from the drop down menu:`defaultscroll`
Viewport Width	`viewportWidth`	`integer`	The width of the viewport for the screenshot
Viewport Height	`viewportHeight`	`integer`	The height of the viewport for the screenshot
Format	`format`	`string`	Select a value from the drop down menu:`mp4movaviwebmgif`
Scroll Delay	`scrollDelay`	`integer`	Delay in milliseconds between scrolls. The default value is `500`
Scroll Duration	`scrollDuration`	`integer`	Duration in milliseconds of one scroll. The default value is `1500`
Scroll By	`scrollBy`	`integer`	By how many pixes scroll. The default value is `1000`
Block Cookie Banners	`blockCookieBanners`	`boolean`	Whether to block cookie banners in the screenshot
Block Ads	`blockAds`	`boolean`	Whether to block ads in the screenshot
Block Trackers	`blockTrackers`	`boolean`	Whether to block trackers in the screenshot
Delay	`delay`	`integer`	The delay before taking the screenshot, in seconds