n8n

Install the community nodes

In a self-hosted n8n instance that permits community nodes, open Settings → Community Nodes and install n8n-nodes-orbitpage. Follow the package's compatibility and restart instructions. Availability in n8n Cloud depends on its community-node review and installation policy.

Create and test the credential

Create a personal API token in OrbitPage Team for the intended workspace. Include workspace:read for the credential test and only the additional scopes needed by the workflow. Store the one-time token in an OrbitPage API credential in n8n, with OrbitPage Base URL set to https://orbitpage.com.

Save and test the credential. The test calls GET /api/v1/workspace. A successful test proves that read is allowed, not that every write, billing or publication action is authorized.

Run a safe first workflow

Add an OrbitPage node, choose Workspace & Draft → Get Workspace Overview and attach the tested credential. Execute the step and confirm the returned workspace identity and revision before adding changes. Use a dedicated test workspace for write experiments.

1. Read the resource immediately before changing it.
2. Pass the current revision into operations that require it.
3. Inspect draft output and perform publication only when intended.
4. Check publication status and the public page before enabling a schedule.

Add triggers and handle failures

OrbitPage Trigger supports draft, publication, custom-domain and Shop state changes. Configure the event and credential in n8n and inspect a test execution before enabling the workflow. Use the package reference for the trigger's delivery model and available event filters.

For 401, check expiry or revocation. For 403, review scopes, membership and plan. For revision_conflict, read again and reapply the intended change. Honor Retry-After on rate limits and inspect prior results before repeating a send, purchase or deletion.