Website Screenshot (customJs) icon

Website Screenshot (customJs)

Take a screenshot of a website

Overview

This node takes a screenshot of a specified website URL. It is useful for scenarios where you need to capture the visual appearance of a webpage, such as generating previews, monitoring website changes, or archiving content. For example, you can input a URL and get back an image file representing how the page looks at that moment.

Properties

Name Meaning
Website Url The URL of the website to capture a screenshot from

Output

The node outputs data in JSON format along with binary data:

  • json: Contains the original input data passed into the node.
  • binary.data: Contains the screenshot image file named output.png. This binary data represents the captured screenshot of the provided website URL.

Dependencies

  • Requires an API key credential for an external screenshot service (referred to generically as "an API key credential").
  • The node sends a POST request to a remote service endpoint to generate the screenshot.
  • The node uses internal helper methods to make HTTP requests and prepare binary data for output.

Troubleshooting

  • Invalid or missing API key: If the API key credential is not set or invalid, the node will fail to authenticate with the screenshot service. Ensure the API key is correctly configured.
  • Invalid URL input: Providing an empty or malformed URL may cause the screenshot service to return errors or no image. Validate URLs before input.
  • Network issues: Connectivity problems between n8n and the external screenshot service can cause timeouts or failures.
  • Binary data preparation errors: If the response from the service is not a valid image, preparing binary data might fail.

Links and References

  • No direct external links are referenced in the code.
  • For best results, consult documentation of the external screenshot API service used with this node.

Discussion