Package Information
Documentation
n8n-nodes-screenshotone
n8n-nodes-screenshotone
is an n8n community node. It lets you use ScreenshotOne in your n8n workflows.
ScreenshotOne is a service that allows you to take screenshots of web pages, generate PDFs, convert HTML or Markdown to images and more.
n8n is a fair-code licensed workflow automation platform.
Installation
Operations
Credentials
Compatibility
Usage
Resources
Development
Version history
License
Installation
Community Nodes
Follow the installation guide in the n8n community nodes documentation:
- Go to
Settings
>Community Nodes
. - Select
Install
. - Enter
n8n-nodes-screenshotone
inEnter npm package name
. - Agree to the risks of using community nodes.
- Select
Install
.
Operations
- Screenshot any website, HTML or Markdown. Returns result as image.
- Full Page Screenshot is the same as Screenshot, but returns the full page as an image.
- PDF from rendering PDFs from URLs, HTML or Markdown. Returns result as PDF.
- Scrolling Screenshot it is a scrolling screenshot feature from ScreenshotOne. Results as video or GIF.
- Record Short Video is to record a short video of a website, HTML or Markdown. Results as video or GIF.
For scrolling screenshots and video check out the ScreenshotOne documentation.
Credentials
To use ScreenshotOne node, you will need to authenticate with the ScreenshotOne API.
- Sign up for or sign in to a ScreenshotOne account.
- Create if needed and copy the API (access) key.
- Create new credentials in n8n:
3.1. Add and use the ScreenshotOne node in your workflow.
3.2. Under "Credential to connect with", click "Create New Credential".
3.3. Paste the API (access) key you copied in step 2.
Test the credentials and make sure it works:
Compatibility
The node was created and tested with n8n version 1.98.2
. But there is no reason it won't work with older and newer versions.
Usage
If you use n8n for the first time, check out the "try it out" documentation to get started.
Response types
ScreenshotOne may return the response in different formats based on the request options:
json
- for JSON responses, e.g. for PDF or screenshot with URLs.text
- for text responses, e.g. raw HTML.base64
- for image responses.
Examples:
{
"content_type": "application/json",
"type": "json",
"response": {
"cache_url": "https://<URL of the screenshot in cache>"
}
}
Or:
{
"content_type": "text/html",
"type": "text",
"response": "<HTML body>"
}
Resources
- n8n community nodes documentation
- ScreenshotOne API documentation
- ScreenshotOne
- ScreenshotOne Dashboard
Version history
- 0.1.0 - Initial release of the ScreenshotOne node for n8n 🥳
Development
Check out documentation on creating nodes for detailed information on building and developing the node.
- Install dependencies:
npm install
- Build the node
npm run build
- Link the node to n8n from the node directory
npm link
- In your
~/.n8n/nodes
directory, link the node:
npm link n8n-nodes-screenshotone
- Run n8n:
n8n start
Once the node is linked, you need to only rebuild and restart n8n to see the changes.
License
License
This project is licensed under the MIT License.