This is a JSSP broker that works with K2 Cloud and K2 Five 5.9 and above. N8N connector for K2

Instructions to upload the broker into your environment can be found here: https://help.nintex.com/en-US/nintexautomation/devref/current/Content/Extend/JS-Broker/JSSPRegister.htm

n8n Broker for K2

The n8n Broker brings n8n's workflow automation capabilities directly into your K2 environment. Through SmartObjects, you can manage workflows, monitor executions, and orchestrate n8n resources all within K2.

Getting Started: Configuration

When you register the broker as a service in K2, you'll need to provide two settings:

Base URL — The root URL of your n8n instance (e.g. https://n8n.mycompany.com).
API Key — Your n8n API key, which is stored securely and encrypted within K2.

The API key is sent as the X-N8N-API-KEY header on every request the broker makes to n8n.

SmartObjects & Methods

The broker exposes five SmartObjects, each mapping to a core resource in the n8n API.

Workflow

A Workflow represents an n8n workflow definition, the canvas of nodes and connections you build in the n8n editor.

Method	Type	Inputs	Parameters	Outputs
Get All Workflows	list	—	active, tags, name, projectId, limit	id, name, active, createdAt, updatedAt, projectId
Get Workflow	read	id	—	id, name, active, createdAt, updatedAt, projectId
Activate Workflow	execute	id	—	id, name, active
Deactivate Workflow	execute	id	—	id, name, active
Delete Workflow	delete	id	—	id, name
Trigger Workflow via Webhook	execute	body (JSON string)	webhookPath (required), testMode	response (JSON string)

Get All Workflows returns a paginated list of all workflows in your n8n instance. You can narrow results by passing optional filters: active (true/false) to show only running or paused workflows, tags as a comma-separated list of tag names, name to search by workflow name, or projectId to scope results to a specific n8n project.

Get Workflow fetches the full details of a single workflow by its ID. Useful when you need to check the current active state or metadata of a specific workflow within a K2 process.

Activate Workflow enables a workflow in n8n so it will respond to its trigger (e.g. a schedule or webhook). Returns the updated workflow with active: true confirmed. Use this when a K2 process needs to turn on an n8n automation as part of a broader business flow.

Deactivate Workflow is the counterpart to Activate — it pauses the workflow so it no longer fires. This is handy for temporarily disabling automations from within a K2 process without deleting the workflow.

Delete Workflow permanently removes a workflow from n8n. This is irreversible, so it is best used in administrative or cleanup scenarios driven by K2.

Trigger Workflow via Webhook posts a JSON payload directly to an n8n Webhook trigger node, starting that workflow immediately. You supply the webhookPath (the path configured in the n8n Webhook node, e.g. my-workflow) and a JSON body string as the data payload. Set testMode = true to call the test webhook endpoint rather than the live production one. The workflow's response is returned as a JSON string in the response output.

Execution

An Execution represents a single run of a workflow. Every time a workflow fires, n8n records it as an execution with a status, start/stop times, and result.

Method	Type	Inputs	Parameters	Outputs
Get All Executions	list	—	status, workflowId, projectId, limit	id, workflowId, status, startedAt, stoppedAt, mode, finished
Get Execution	read	id	—	id, workflowId, status, startedAt, stoppedAt, mode, finished
Delete Execution	delete	id	—	id, status
Retry Execution	execute	id	—	id, status
Stop Execution	execute	id	—	id, status

Get All Executions lists historical execution records across your n8n instance. Filter by status (canceled, error, running, success, waiting), by workflowId to see runs for a specific workflow, or by projectId. Useful for building audit or monitoring views in K2.

Get Execution retrieves the full detail record for a single execution by its numeric ID, including when it started, when it stopped, whether it finished, and its final status.

Delete Execution removes an execution record from n8n's history. Typically used for housekeeping, clearing out old or irrelevant execution logs from an administrative K2 process.

Retry Execution re-runs a previously failed or errored execution using the same input data it originally received. This is useful when a workflow failed due to a transient issue (e.g. a downstream service was temporarily unavailable) and you want K2 to trigger a retry without manual intervention in n8n.

Stop Execution halts a currently running execution mid-flight. Use this when a K2 process determines that an in-progress n8n workflow run should be cancelled , for example, if a related business process was withdrawn by a user.

Credential

A Credential represents a saved credential set in n8n, such as an OAuth token, API key, or database connection stored within n8n for use by nodes.

Method	Type	Inputs	Parameters	Outputs
Get All Credentials	list	—	limit	id, name, type, createdAt, updatedAt
Delete Credential	delete	id	—	id, name, type

Get All Credentials returns a list of all credential records stored in n8n, including their name and type (e.g. httpBasicAuth, googleOAuth2Api). Note that credential secrets are never exposed — only the metadata is returned.

Delete Credential permanently deletes a credential record from n8n. This is a destructive operation intended for administrative cleanup, such as revoking access when a user or integration is decommissioned.

Tag

Tags in n8n are labels you can apply to workflows to organise and filter them.

Method	Type	Inputs	Parameters	Outputs
Get All Tags	list	—	limit	id, name, createdAt, updatedAt
Get Tag	read	id	—	id, name, createdAt, updatedAt
Create Tag	create	name	—	id, name
Update Tag	update	id, name	—	id, name
Delete Tag	delete	id	—	id, name

Get All Tags lists all tags defined in your n8n instance. Useful as a lookup list in K2 forms when you want users to filter or associate workflows by tag.

Get Tag fetches a single tag by its ID, returning its name and timestamps. Use this to verify a tag exists or to display its details within a K2 view or form.

Create Tag creates a new tag in n8n with the given name. This enables K2 processes or administrators to dynamically add organisational labels without having to open the n8n UI.

Update Tag renames an existing tag. Because tags are referenced by ID in n8n, renaming via K2 propagates the change across all workflows that use it.

Delete Tag permanently removes a tag from n8n. The tag will be unlinked from any workflows it was applied to.

User

A User represents a user account in your n8n instance.

Method	Type	Inputs	Parameters	Outputs
Get All Users	list	—	projectId, limit	id, email, firstName, lastName, isPending, role, createdAt, updatedAt
Get User	read	id	—	id, email, firstName, lastName, isPending, role, createdAt, updatedAt
Delete User	delete	id	—	id

Get All Users returns a list of all user accounts in n8n, including their role, email, and whether their invitation is still pending. Optionally filter by projectId to see only users belonging to a specific n8n project.

Get User fetches the full profile of a single n8n user by ID. Useful when a K2 process needs to verify user details or role before taking an action.

Delete User removes a user account from n8n. Intended for offboarding scenarios where deprovisioning n8n access should be part of an automated K2 workflow.

A Note on Inputs vs Parameters

In K2 SmartObjects there is an important distinction between these two concepts:

Inputs are property values on the SmartObject instance. For example, you load a Workflow record, set id, and then call the method.

Parameters are additional filter or option values passed directly to the method call. They are not tied to a property, for example, setting active=true when listing workflows.

All "Get All" methods support a limit parameter with a maximum value of 250. If omitted, the n8n API default applies.

Comments

Comments