---
title: "n8n · Scrape.ly Docs"
description: "Run Actors, read results, and start n8n workflows when a run finishes."
url: https://scrape.ly/docs/n8n
markdown: https://scrape.ly/docs/n8n.md
---

# n8n

> Run Actors, read results, and start n8n workflows when a run finishes.

The `n8n-nodes-scrapely` community node connects Scrape.ly to [n8n](https://n8n.io): run Actors and saved tasks, read their results, and start workflows when a run finishes. Its source code is on GitHub: [scrapely-app/n8n-nodes-scrapely](https://github.com/scrapely-app/n8n-nodes-scrapely).

## Install

In n8n, go to **Settings → Community nodes → Install** and enter `n8n-nodes-scrapely`.

## Credentials

Create a **Scrapely API** credential and paste an API key from the [dashboard](https://my.scrape.ly) (**Settings → API keys**). Leave **Base URL** as `https://api.scrape.ly`. A scoped key needs the scopes of what your workflows do: `actors:run`, `runs:read`, and `datasets:read` to run Actors and read their results, and `webhooks:write` for the trigger. See [API keys & permissions](https://scrape.ly/docs/api-keys.md).

## Scrapely node

| Resource | Operation | What it does |
|---|---|---|
| Actor | Run | Starts a run with the input you give (JSON). |
| Actor | Get Last Run | Returns the most recent run of the Actor. |
| Task | Run | Starts a run of a [saved task](https://scrape.ly/docs/integrations.md#tasks), optionally overriding parts of its input. |
| Run | Get | Returns a run by ID. |
| Dataset | Get Items | Returns items from a dataset, with limit and offset. |
| Key-Value Store | Get Record | Returns one record, for example `OUTPUT`. |

**Run** options:

- **Wait for Finish** (on by default): waits until the run has finished, up to **Max Wait** seconds.
- **Return Results** (on by default): outputs the run's dataset items, one n8n item each, instead of the run. A run that did not succeed stops the workflow with its status.
- **Options**: build, memory, and timeout for the run.

n8n AI agents can use the node as a tool.

## Scrapely Trigger

Starts the workflow when a run of an Actor or a task finishes. Pick the events: succeeded, failed, timed out, or aborted. When the workflow is activated, the trigger registers a [webhook](https://scrape.ly/docs/integrations.md#webhooks) in your Scrape.ly account, and removes it when the workflow is deactivated. It counts toward your webhook limit and is listed under **Automations → Webhooks**.

Turn on **Include Results** to get the run's dataset items instead of the event.

---

- Previous: [LlamaIndex](https://scrape.ly/docs/llama-index.md)
- Next: [JavaScript client](https://scrape.ly/docs/client-js.md)
- All docs: [Docs index](https://scrape.ly/docs.md), [llms.txt](https://scrape.ly/llms.txt)