Skip to main content
Last updated on

n8n Node Reference

The OpenBox n8n integration connects an n8n AI Agent node to OpenBox through a community node that ports the same governance middleware used by the OpenBox LangChain SDK. It governs agent lifecycle, model calls, and tool calls while keeping your existing Chat Model, Memory, and Tool connections unchanged.

Published package: n8n-nodes-openbox-hook

GuideDescription
Integration WalkthroughEnd-to-end guide for installing the node, adding credentials, replacing your AI Agent node, and verifying live runs
ConfigurationCredential fields, node parameters, and current governance defaults
Error HandlingNode errors, approval outcomes, guardrail failures, and Continue On Fail behavior
Event ModelUnderstand agent runs, model calls, tools, signals, and how they appear in OpenBox
Approvals and GuardrailsHow verdicts are enforced and how to test live guardrails correctly
TelemetryHTTP and database capture behavior
TroubleshootingDiagnose installation, credential, policy, and telemetry issues
What The Node Does

The node's job is to connect an n8n agent to OpenBox. Trust policy, approvals, guardrails, dashboards, and operator workflows live on the OpenBox platform, not inside the node.

Philosophy

The integration is intentionally minimal:

  • One node, OpenBox: Agent, that replaces the standard AI Agent node
  • No rewrite of existing Chat Model, Memory, or Tool sub-nodes
  • Automatic governance at agent, model, and tool boundaries
  • Automatic HTTP and database telemetry through the node's built-in instrumentation

Recommended Entry Point

For most workflows, add the node and attach the sub-nodes your agent already uses:

workflow.json (node excerpt)
{
"type": "n8n-nodes-openbox-hook.openBoxAgent",
"typeVersion": 1,
"parameters": {
"promptType": "auto",
"options": {
"systemMessage": "You are a helpful assistant"
}
},
"credentials": {
"openBoxApi": {
"id": "1",
"name": "OpenBox API"
}
}
}

Newly created OpenBox agents require DID signing by default. Configure Agent DID and Agent Private Key together on the credential unless Require signing is disabled for the registered agent.

What The Node Captures

OpenBox receives:

Agent Boundaries

  • WorkflowStarted
  • WorkflowCompleted
  • SignalReceived(user_prompt)

Model Boundaries

  • LLMStarted
  • LLMCompleted

Tool Boundaries

  • ToolStarted
  • ToolCompleted

Operational Telemetry

  • HTTP requests, including the model provider call itself
  • database queries when the workflow uses a database node or tool, excluding n8n's own internal Postgres connection

Supported Runtime Conditions

RequirementValue
n8nCommunity Nodes enabled
Node.jsn8n's supported runtime
n8n-workflow (peer dependency)>=1.0.0
OpenBox Corehttps://core.openbox.ai (fixed; not user-configurable in the credential)

Next Steps

  1. Start with the Integration Walkthrough.
  2. Review current defaults in Configuration.
  3. Read Event Model before writing policy or guardrails.