Documentation

How to use Okum

Last updated Nov 2026 · 7 min read

On this page
  1. Getting started — connect & scan
  2. Understanding errors & verdicts
  3. Alerts (email & Slack)
  4. Client portal
  5. Verdict feedback & memory
  6. FAQ
Section 01

Getting started

Connect your n8n server and run your first scan in under 5 minutes.

1
Create your Okum account

Go to okum.cloud and sign up. Choose a plan or start the 14-day free trial — no credit card required. You'll land on the Overview screen.

2
Connect your n8n server

Go to n8n Servers → Add server. Enter a name, your n8n instance URL (e.g. https://n8n.yourdomain.com), and an n8n API key. The API key must have read access to workflows and executions. Okum will immediately verify the connection.

3
Run your first history scan

Go to Run History → Scan now. Okum reads your last 90 days of execution history and classifies every failure. This takes 10–30 seconds. After the scan, the Errors screen shows all incidents grouped and classified — ready to review.

4
Add your clients

Go to Clients → Add client. Enter the client's name. Then go to Workflows and assign each workflow to its client. This tells Okum which failures to show on each client's portal.

5
Enable workflows for monitoring

In the Workflows screen, toggle on the workflows you want Okum to actively monitor. Only toggled workflows appear in the Errors screen and trigger alerts. You can toggle them on or off at any time.

💡 Tip
Okum syncs automatically every 15 minutes after the first scan. You don't need to run scans manually after setup.
Section 02

Understanding errors & verdicts

Every failure gets a verdict — whose side it is and what to do about it.

When a workflow fails, Okum reads the error message and classifies it into one of these verdicts:

Verdict What it means Who fixes it
Workflow Bug Your workflow code or logic has a problem — wrong node, bad expression, missing field. You (the agency)
Credential Expired A connected account (Google, Slack, HubSpot…) has expired and needs re-authentication. Your client
Client Data Changed The workflow ran but the data it expected (a column, a field) no longer exists on the client's side. Your client
Service Issue A third-party API (Google Sheets, OpenAI, Stripe…) returned an error. Usually temporary. Wait and retry
Needs Review Okum couldn't classify this error. It needs a human look. You (check and feedback)

Why this verdict — transparency

Click any error row to open the detail panel. At the bottom you'll see "Why this verdict" — the exact rule that matched and the exact text from the error message. This means you always know why Okum decided what it did, and you can correct it if it's wrong.

Silent failures

Some workflows finish with a green status but do nothing — because a node silently swallowed the error (continueOnFail was on). Okum catches these too and flags them as Silent failure. They won't appear in n8n's error list, only in Okum.

Correcting a verdict

If Okum got it wrong, go to the error's detail panel → Acknowledge → choose No, it was wrong and select the correct cause. Okum stores this correction and uses it to improve future classifications for similar errors.

Section 03

Alerts

Get notified the moment a client's workflow breaks — with the verdict already included.

📧
Email alerts
Set up in Settings → Notifications. Every alert email includes the workflow name, the client, the verdict, and what to do next.
💬
Slack alerts Pro
Connect your Slack workspace and choose a channel. Alerts go there immediately when a failure is detected.
🔇
Blind server alerts
If Okum can't reach your n8n server for 30+ minutes, it sends a separate "server unreachable" alert. Never go dark silently.
⚠️ Important
Alerts are only sent for workflows that have monitoring toggled on in the Workflows screen. Make sure to enable the workflows you care about.
Section 04

Client portal

Your client gets a branded page showing their automation health — no n8n access needed.

1
Find the portal link

Go to Clients → [Client name]. Each client has a unique portal URL that you share with them. The link is permanent.

2
Brand it with your agency

Go to Settings → Branding. Upload your agency logo and set your brand color. The portal shows your branding — not Okum's. Your client sees it as your tool.

3
Add useful links (optional)

Go to Settings → Portal Links. Add links your client may need — a Slack channel, a booking link, your support email. These appear on every client's portal.

4
Share the link

Send the portal URL to your client. They can bookmark it. It works on mobile too. No login required — the link itself is the access control.

💡 What your client sees
The portal shows: automations that are live, any open problems, when each workflow last ran, and a simple status summary. They never see your n8n credentials, other clients' data, or Okum's internal screens.
Section 05

Verdict feedback & memory

The more you correct Okum, the smarter it gets on your account.

1
Acknowledge an error

On any error in the Errors screen, click the row to open the detail panel. Click Acknowledge. You'll be asked: "Was this verdict correct?"

2
Confirm or correct

If correct, tap Yes, correct. If wrong, tap No, it was wrong and pick the real cause from the list. If Okum said "Unknown", tap I know what this is and identify it.

3
Fingerprint memory

The next time a similar error appears on the same workflow, Okum shows a purple "Okum remembers" box — it tells you what you corrected last time and asks if the same fix applies. This saves you from re-identifying the same issues every time.

Verdict Accuracy tab

Go to Settings → Verdict Accuracy to see your overall accuracy percentage and a list of every correction you've made. You can edit or remove any correction if it was wrong. This is the data Okum uses to improve its classifications on your account.

Section 06

FAQ

Common questions about Okum.

Why is my scan showing old data or not updating?

Okum auto-syncs every 15 minutes. If you just made changes in n8n, wait 15 minutes or go to Run History → Scan now to force an immediate sync. If errors still don't appear, check that the workflow is toggled on in the Workflows screen.

What is a silent failure?

A silent failure is when a workflow finishes with a green status (no error) but actually did nothing — because a node had continueOnFail on and swallowed the error silently. n8n's own error workflow cannot catch these. Okum detects them by reading the execution data, not just the final status.

Can my client see n8n, my credentials, or other clients' data?

No. The client portal shows only the workflows assigned to that specific client — just the name, status, and last-run time. They see no n8n interface, no credentials, and nothing about other clients. Okum never stores your n8n credentials after verification.

What happens if Okum's verdict is wrong?

Acknowledge the error and choose No, it was wrong. Pick the correct cause. Okum stores your correction and uses it for future errors with the same fingerprint. You can also edit or delete corrections any time in Settings → Verdict Accuracy.

What plans include Slack alerts and multiple clients?

Slack alerts and multiple client portals are available on the Pro and Agency plans. The Starter plan includes email alerts and one client portal. You can upgrade any time — your data is kept.

How do I add a second n8n server?

Go to n8n Servers → Add server and add another. Each server can have its own workflows and clients. The Agency plan supports multiple servers; the Starter and Pro plans support one.