Skip to content
BredboxHelp

Automate with n8n

n8n is a workflow automation platform. The Bredbox community node exposes the Bredbox REST API as workflow steps, so your library can be a source, a destination, or a stage in the middle of something bigger — collect links from a form and save them, tag everything from a given site, mirror new saves into a spreadsheet, kick off a weekly export.

Before you start

Section titled “Before you start”

You need:

  1. The Pro plan, which includes developer features. See Manage your plan and data.
  2. An n8n instance where you can install community nodes. Self-hosted instances allow this by default; on n8n Cloud, community nodes are enabled per plan.
  3. A Bredbox API token that includes the user:read scope, plus whatever scopes your workflow needs. See Use API tokens.

Install the node

Section titled “Install the node”

  1. In n8n, open Settings → Community nodes.

  2. Click Install a community node.

  3. Enter the package name:

    @bredbox/n8n-nodes-bredbox

  4. Accept the risks prompt and install.

Bredbox now appears in the node panel when you search for it.

Connect your account

Section titled “Connect your account”
  1. Add a Bredbox node to a workflow.
  2. Under Credential to connect with, create a new credential of type Bredbox API.
  3. Paste your API token into Access Token.
  4. Leave API Base URL at https://api.bredbox.app/v2 unless you are pointing at a local development instance.
  5. Save. n8n tests the credential by fetching your account profile, so a green result means the token works.

The connection test needs the user:read scope. That test calls GET /v2/me, which is guarded by user:read — so a token without it fails the test with an insufficient_scope error even when every scope your actual workflow needs is present. Include user:read on any token you use with n8n.

Beyond that, give the token only the scopes your workflow needs: a node that just creates saves needs saves:write and user:read, nothing more. See Choose the smallest scope you need.

Section titled “Save a link from a workflow”
  1. Add a Bredbox node and select your Bredbox API credential.
  2. Set Resource to Save.
  3. Set Operation to Create.
  4. Put the web address in the URL field — type it, or map it from an earlier node.
  5. Execute.

That’s the whole thing. Everything else Bredbox normally does for a save — fetching the title, site name, description, preview image, and reading content — happens on its side, in the background.

What the node can do

Section titled “What the node can do”
Resource Operations
Save Create, Delete, Get, Get Content, Get Many, Get Tags, Restore, Search, Set Tags, Tags Add, Update
Highlight Create, Delete, Get Many, Update
Tag Get Many, Get Saves
Collection Create, Get, Get Many, Update, Delete, Add Item, Get Item, Get Items, Update Item, Delete Item
Import Create, Get Many
Export Create, Download, Get Many
Webhook Create, Get, Get Events, Get Many, Update, Delete
Token Create, Get, Get Many, Get Scopes, Regenerate, Update, Delete
Authorization Get Many, Delete
Me Get Profile, Get Job, Clear Data, Confirm Privacy Action, Delete Account

Every operation maps onto a documented endpoint. When you need to know exactly what a field means or what comes back, the API reference is the source of truth.

Note that Me → Delete Account and Me → Clear Data are as destructive as they sound. Keep them out of workflows that run on a schedule.

Trigger a workflow from Bredbox

Section titled “Trigger a workflow from Bredbox”

The node reads and writes on demand — it does not listen for events. To have Bredbox start an n8n workflow, put an n8n Webhook trigger at the front of the workflow and register its URL as a Bredbox webhook. Subscribe to the events you care about, such as save.created or save.metadata.completed, and verify the signature before acting on the payload.

If something stops working

Section titled “If something stops working”
  1. 401 responses — the token expired, was revoked, or was regenerated. Create a new one and update the credential.
  2. The credential test fails but the workflow looks right — the token is almost certainly missing user:read. The test fetches your profile, not your saves.
  3. insufficient_scope errors — the token is missing a scope. The error names the one it needs.
  4. The node doesn’t appear after installing — some n8n deployments need a restart before a newly installed community node shows up.
  5. Everything fails at once — check that your plan still includes developer features.

Tokens you use with n8n are listed under Settings → Tokens in Bredbox, where you can revoke one at any time.

Section titled “Related guides”