Integrate with n8n

Overview

GetScreenshot provides an official community node for n8n, the popular open-source workflow automation platform. Capture screenshots and PDFs of web pages directly in your n8n workflows, whether self-hosted or using n8n cloud.

Requirements

  • GetScreenshot API Key - Get one here
  • Hamilton Plan or higher - Required for n8n integration
  • n8n instance - Self-hosted or n8n cloud

Installation

  1. Open your n8n instance
  2. Go to Settings > Community Nodes
  3. Click Install a community node
  4. Enter: n8n-nodes-getscreenshot
  5. Click Install

Via npm (Self-hosted)

If you’re running n8n with npm, install the node globally:

npm install -g n8n-nodes-getscreenshot

Then restart your n8n instance.

npm package: n8n-nodes-getscreenshot


Credentials Setup

  1. In n8n, go to Credentials > New Credential
  2. Search for “GetScreenshot API”
  3. Enter your API key
  4. Click Save

The credentials are automatically validated using the /validate-key endpoint.


Available Operations

Operation Description
Take Screenshot Capture a screenshot or PDF of a webpage with customizable options
Get Usage Check your current API quota and usage statistics

Device Presets

Quickly capture screenshots using common device dimensions:

Category Presets
Mobile iPhone 12, iPhone X, iPhone 6/7/8, Pixel 2
Tablet iPad, iPad Pro
Desktop HD (1280×800), HD+ (1366×768), SXGA, WSXGA+

Output Formats

Format Description
PNG Default format, lossless compression
JPEG Smaller file size, lossy compression
WebP Modern format with excellent compression
PDF Document format with paper size options

Screenshot Options

Viewport Settings

Option Description
Custom width and height Set exact pixel dimensions
Device scale factor 1x, 2x, or 3x for Retina displays
Device preset Use predefined device dimensions

Timing Options

Option Description
Wait until condition load, domcontentloaded, networkidle0, networkidle2
Additional wait time Extra milliseconds to wait
Scroll page Trigger lazy-loaded content before capture

Element Targeting

Option Description
Capture specific element Target by CSS selector
Hide elements Remove elements before capture
Click element Interact with page before capture

Page Modifications

Option Description
Auto-hide cookie banners Automatically remove consent dialogs
Highlight text Mark specific words with yellow highlight
Inject custom CSS Add styles before capture
Execute custom JavaScript Run scripts before capture

Delivery Options

Option Description
Email screenshot Send to email address
POST to webhook Async delivery to your endpoint

Usage Examples

Basic Screenshot

  1. Add a GetScreenshot node to your workflow
  2. Select Take Screenshot operation
  3. Enter the URL to capture
  4. Choose a device preset or use custom dimensions
  5. The node outputs both:
    • JSON data: URL, dimensions, status
    • Binary data: The actual screenshot image

Full Page PDF

  1. Set URL to capture
  2. Set Output Format to “PDF”
  3. Enable Full Page
  4. Add option PDF Paper Format and select A4
  5. Connect to a Write File node to save the PDF

Screenshot with Modifications

  1. Set URL to capture
  2. Add options:
    • Hide Elements: .ads, .popup
    • Custom CSS: body { background: white; }
    • Additional Wait Time: 2000

Output Schema

The Take Screenshot operation returns:

JSON Output

{
  "status": "ok",
  "url": "https://example.com",
  "screenshotUrl": "https://storage.googleapis.com/...",
  "width": 1280,
  "height": 800,
  "format": "png",
  "fullPage": false,
  "capturedAt": "2026-01-15T10:30:00.000Z"
}

Binary Output

The screenshot image is attached as binary data named data, ready for use with downstream nodes:

  • Write Binary File - Save to disk
  • Send Email - Send as attachment
  • AWS S3 / Google Cloud Storage - Upload to cloud
  • HTTP Request - Send as multipart form data

Alternative: HTTP Request Node

If you prefer not to install the community node, you can use n8n’s built-in HTTP Request node:

Configuration:

  • Method: GET
  • URL: https://api.rasterwise.com/v1/get-screenshot
  • Query Parameters:
    • apikey: Your API key
    • url: Target URL
    • fullpage: true/false
    • width: Viewport width
    • height: Viewport height

See the API Reference for all available parameters.


Troubleshooting

Node not appearing after installation

  • Restart your n8n instance
  • Check that the node is listed in Settings > Community Nodes

“Invalid API key” error

  • Verify your API key in the credentials
  • Ensure you have Hamilton Plan or higher

Screenshot is blank or incomplete

  • Increase the wait time in options
  • Try different “Wait until” settings
  • Enable “Scroll page” for lazy-loaded content

Timeout errors

  • Use the webhook delivery option for complex pages
  • Reduce wait times and page complexity

Support


Integrate with Make.com
Integrate with Google Sheets

Related Docs