Skip to content

n8n

There are two ways to connect Orimora and n8n, depending on which side starts the flow:

You want to…Use
Start a workflow when something changes, or read/write contentThe community node n8n-nodes-orimora (Trigger + Action)
Push one specific document out on demand or on publishA “Send to” push endpoint pointing at an n8n Webhook

n8n-nodes-orimora ships an Orimora Trigger (start a workflow on a change event) and an Orimora Action (read/write documents and collections from any step). The trigger auto-registers and deregisters its webhook when you activate/deactivate the workflow.

  1. Install n8n-nodes-orimora. The npm-registry release follows in open beta; until then install from source from the repository. Once published, this becomes Settings → Community Nodes → install n8n-nodes-orimora.
  2. In Orimora, go to Settings → Developers → API Keys and create a key with read + write scopes.
  3. In n8n, create an Orimora API credential with that API key and your Orimora base URL.
  4. Add an Orimora Trigger node (pick the events) or an Orimora Action node (pick the operation) to your workflow.

Trigger events: document.created, document.updated, document.deleted, document.published, collection.created, collection.updated, collection.deleted, notification.created.

Action operations: Document — Get, Get Many (filter by collection, parent, title, status, tags, trash, or updatedSince), Create, Update, Delete, Restore · Collection — Get, Get Many, Create, Export (ZIP) · Tag — Get Many, Create.

Option B — a “Send to” push endpoint

Section titled “Option B — a “Send to” push endpoint”

When you want to push one chosen document (manually or automatically on publish) rather than react to every workspace event, use a Send-to endpoint that targets an n8n Webhook trigger node.

  1. In n8n, add a Webhook node and copy its URL.
  2. In Orimora, Settings → Send-to endpoints → New endpoint, paste the n8n Webhook URL, and store the generated signing secret.
  3. Send a document from its menu (“Send to…”), or toggle “Auto on publish” to send it on every publish.

The payload is a POST with the document as Markdown plus an HMAC signature — see Send to → Payload & signature for the exact body and verification.

  • Community node — bidirectional, reacts to any workspace change, and can also read/write back into Orimora. Best for general automation.
  • Send-to endpoint — one-way, document-scoped, signed. Best for “publish this one document to my pipeline” without subscribing to everything.