n8n-nodes-orbitpage: OrbitPage automation for n8n

n8n-nodes-orbitpage is the official OrbitPage community node package for
n8n. It connects n8n workflows to
OrbitPage, a one-page website and link-in-bio builder.
It lets you automate a hosted OrbitPage workspace directly from n8n workflows.

Use the OrbitPage node to read page data, update drafts, publish reviewed
changes, upload media, check analytics, and manage supported workspace
features. Use OrbitPage Trigger to start a workflow when a draft,
publication, custom domain, or Shop state changes.

Typical automations connect forms, databases, content systems, and scheduled
workflows to an OrbitPage public page. Start with the read-only workflow below.
Operations that publish, send, delete, or bill state their effect explicitly in
the editor.

Contents

• Requirements and compatibility
• Installation
• End-to-end quick start
• Choose the right operation
• Nodes
• Request bodies and output
• Operation catalog
• Safety
• Documentation
• Troubleshooting
• Development
• License

Requirements and compatibility

If you must use an older n8n 1.x installation or a materially newer runtime,
validate the package and your workflow in a staging instance before production.

OrbitPage features remain subject to the workspace plan, token scopes, and
account permissions.

Installation

Self-hosted n8n UI

As an n8n instance owner, open Settings > Community Nodes, select
Install, and enter:

n8n-nodes-orbitpage

Restart self-hosted n8n if your installation requires it.

Self-hosted command line

From the community-nodes directory used by your n8n installation, run:

npm install n8n-nodes-orbitpage

Restart n8n after installation. See the
getting-started guide for the complete setup
and recovery steps for partial installations.

End-to-end quick start

1. In OrbitPage, open Dashboard > Team > Personal API tokens.

2. Create a token for this workflow with workspace:read for the initial
   connection test and first safe read.

3. In n8n, create an OrbitPage API credential with:

   Field	Value
   OrbitPage API Token	The one-time op_pat_... secret copied from OrbitPage
   OrbitPage Base URL	https://orbitpage.com

4. Save and test the credential. The credential test calls
   GET /api/v1/workspace, so it requires workspace:read even when the final
   workflow only performs another operation.

5. Add the OrbitPage node and select
   Workspace & Draft → Get Workspace Overview.

6. Attach the credential and select Execute step. This first request does
   not change data. The output contains the token-bound workspace, its current
   revision, and usage information.

You can also import examples/read-workspace.json
or examples/watch-publication.json. Replace
the placeholder credential reference after import; never place a token in
workflow JSON. See examples/README.md for details.

Choose the right operation

Choose the resource first, then the operation. The operation description states
what changes, whether it becomes public, and which scope is required. Use the
operation matrix when building a least-privilege token.

Nodes

OrbitPage

The action node groups related operations under Workspace & Draft,
Page Content (Blocks), Profile, Theme, Subpages,
Page Settings, Publication, Media Library,
Custom Domain & DNS, Analytics, AI Page Editing, Shop,
Newsletter, Team & Invitations, Backups & Versions, and
Billing & Plans. Advanced API provides relative custom requests.

Writes that use optimistic concurrency can fetch the current revision
automatically and send it as If-Match. Binary convenience operations handle
the reserve, signed upload, and finalize sequence without sending the OrbitPage
bearer token to the storage host.

OrbitPage Trigger

The trigger polls a selected OrbitPage resource:

The first production poll establishes a baseline and emits nothing unless
Run on First Poll is enabled. A manual test always returns the current
state. This is state polling, not an event log: if a resource changes several
times between polls, the trigger emits the latest observed state rather than
replaying every intermediate change.

The Shop trigger explicitly requests refresh=0. Unlike the normal Get Shop
Overview action, polling does not initialize Shop data or refresh Stripe
connection state.

Get Shop Overview exposes the same behavior as Shop Read Mode:

Request bodies and output

Possible effect labels

The editor identifies every possible effect before the operation's inputs. An
operation can show more than one label when its outcome depends on a setting or
combines elevated access with another side effect:

Request Body (JSON)

For a write operation, Request Body (JSON) is the JSON value sent to OrbitPage.
Do not wrap it in body or data unless the operation schema explicitly
requires that property. For example, use the following body with Media
Library → Preview or Delete Unused Media to preview without deleting:

{
  "dryRun": true
}

When the editor marks the body as optional, leave {} to use the operation's
defaults.

Use n8n expression mode to map the whole JSON value or individual values from
the current input item. Revision fields remain separate: Revision Check adds
If-Match automatically or accepts a revision from an earlier read. Compare
the body with the public
OpenAPI contract because strict
operations reject unknown fields.

Output shapes

Request bodies use the closed, named schemas in OpenAPI and reject unsupported
fields. Response objects remain forward-compatible: map only fields documented
for your operation and allow OrbitPage to add new response fields.

See Revisions and publishing before a
draft write and Binary uploads before mapping
n8n binary data.

Operation catalog

The catalog contains all 65 workspace operations in the public
OpenAPI 3.1 contract, plus three n8n
convenience operations for binary uploads and custom requests.

Use the generated operation matrix to find the method,
relative path, required scope, request-body requirement, and revision source for
each operation. The matrix is generated from the typed catalog and must not be
edited manually.

Safety

• Use one token per workflow and environment, with only the required scopes.
• Store bearer tokens only in n8n credentials. Do not put them in workflow JSON,
  expressions, logs, screenshots, or support messages.
• Review revision-controlled writes before publishing. When a 409 Conflict
  returns code: revision_conflict, read the latest state and intentionally
  reapply the change. For every other 409, resolve the business condition
  identified by error.code before retrying.
• Review restore inputs before execution: version and backup restores replace
  page data and publish the restored result immediately.
• The action node can be exposed to n8n AI agents as a tool and includes
  publishing, restore, deletion, email, and billing operations. Do not give an
  unattended agent a broad credential; require human review for destructive or
  externally visible actions.
• Prefer the reviewed AI Page Editing > Preview AI Page Changes then
  AI Page Editing > Apply Previewed AI Changes flow.
  A provider key is not an OrbitPage credential and must never be pasted into
  this node.
• Use guided operations when available. A custom API request can use every
  applicable workspace permission held by its selected credential and remains
  limited to the public workspace API contract.

Read the focused guides on
credentials and scopes,
revisions and publishing,
binary uploads, and
AI safety.

Documentation

• Documentation index
• Getting started
• Complete operation matrix
• Example workflows
• Version history
• Code of Conduct
• OrbitPage API, token, and n8n integration guide
• n8n community-node installation

Troubleshooting

The troubleshooting guide includes diagnostic
requests, installation recovery, trigger behavior, upload failures, and manual
revision guidance.

Development

npm ci
npm run check

npm run check lints, builds, verifies package loading, checks generated
operation documentation, and runs the test suite. Read
CONTRIBUTING.md and the
development and release guide before
changing the operation catalog or preparing a release.

License

MIT © Paolo Ronco