TypeScript SDK
The TypeScript SDK connects external Node.js/browser applications to NoClick workflows via WebSocket (Socket.IO). Itβs also the SDK used inside custom components.
Installation
socket.io-client is required for external apps (WebSocket transport). Custom components donβt need it, since the SDK uses postMessage in iframe context.
Quick Start
Authentication
External apps use API keys created in Settings > Developer. Keys have three permission levels:
| Permission | Allows |
|---|
read | nodes.getOutput, nodes.list, nodes.getConfig, state.get, state.keys, dataset.getRows, resources.list, auth.listCredentials |
execute | execution.runNodesAndGetOutput, execution.runNodesInBackground, execution.stop |
write | nodes.setConfig, state.set, state.del, dataset.appendRows, dataset.create, resources.upload, auth.createCredential |
Reading Data
Running Nodes
State Management
Requires a State Manager node in the workflow.
Real-time Subscriptions
Subscribe to node changes from any trigger (cron, webhooks, manual runs, other SDK clients):
Credentials
auth.requestCredential() (OAuth popup flow) is only available in custom components, not external apps.
Resources (File Storage)
Dataset CRUD
Workflow Info
Full API Reference
See the API Reference for complete method signatures with TypeScript and Python examples side by side.