n8n Custom Node — NPM Package Skill#

Core Mental Model#

Every n8n node follows one pattern:

text

getInputData()  →  loop items  →  do stuff  →  push to returnData  →  return [returnData]

Two file types do all the work:

• Node file ( nodes/MyNode/MyNode.node.ts) — UI fields + execute logic
• Credential file ( credentials/MyApi.credentials.ts) — auth definition

Everything else is project plumbing.

---

Project Structure#

text

n8n-nodes-yourservice/
├── package.json              ← CRITICAL: must have n8n section + correct keyword
├── tsconfig.json
├── .eslintrc.js
├── gulpfile.js               ← copies SVG icons to dist/
├── index.js                  ← optional explicit entry point
├── nodes/
│   └── YourService/
│       ├── YourService.node.ts
│       ├── YourService.node.json   ← optional: codex metadata
│       └── yourservice.svg
├── credentials/
│   └── YourServiceApi.credentials.ts
└── dist/                     ← compiled output (never edit manually)

---

What to Read and When#

This skill has focused reference files. Load only what you need:

Node Types (pick one)#

If you need...ReadStandard request/response node (most common)references/examples/nodes/programmatic-node.mdSimple REST API, no complex logicreferences/examples/nodes/declarative-node.mdTrigger that polls an API on a schedulereferences/examples/nodes/trigger-node.mdWebhook that receives HTTP callsreferences/examples/nodes/webhook-node.md

Credentials (pick what matches your auth)#

Auth typeReadAPI key, Bearer token, custom header, query keyreferences/examples/credentials/api-key-patterns.mdOAuth2 (user login or machine-to-machine)references/examples/credentials/oauth2-patterns.mdBasic auth, multi-field, manual injectreferences/examples/credentials/other-patterns.md

Concepts (load when the topic comes up)#

TopicReadUI field types, displayOptions, collections, fixedCollectionreferences/concepts/node-properties.mdHTTP requests, bodies, headers, responses, binaryreferences/concepts/http-and-binary.mdError types, continueOnFail, NodeApiError vs NodeOperationErrorreferences/concepts/error-handling.mdpairedItem, data flow, why item tracking mattersreferences/concepts/data-and-pairing.mdNode versioning, updating without breaking workflowsreferences/concepts/node-versioning.md

Project Setup & Publishing#

TopicReadpackage.json, tsconfig, gulpfile, eslintrc, index.jsreferences/templates/project-files.mdLocal testing, npm link, n8n startreferences/templates/local-testing.mdnpm publish, GitHub Actions, provenancereferences/templates/publishing.mdCommon gotchas and silent failuresreferences/gotchas/common-gotchas.md

---

Quick-Start Pattern (copy this first)#

typescript

// nodes/YourService/YourService.node.ts
import {
  IExecuteFunctions,
  INodeExecutionData,
  INodeType,
  INodeTypeDescription,
  NodeOperationError,
} from 'n8n-workflow';

export class YourService implements INodeType {
  description: INodeTypeDescription = {
    displayName: 'Your Service',
    name: 'yourService',
    icon: 'file:yourservice.svg',
    group: ['transform'],
    version: 1,
    description: 'Interact with Your Service API',
    defaults: { name: 'Your Service' },
    inputs: ['main'],
    outputs: ['main'],
    credentials: [{ name: 'yourServiceApi', required: true }],
    properties: [
      {
        displayName: 'Endpoint',
        name: 'endpoint',
        type: 'string',
        default: '/users',
        required: true,
      },
    ],
  };

  async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
    const items = this.getInputData();
    const returnData: INodeExecutionData[] = [];
    const credentials = await this.getCredentials('yourServiceApi');

    for (let i = 0; i < items.length; i++) {
      try {
        const endpoint = this.getNodeParameter('endpoint', i) as string;

        const response = await this.helpers.httpRequest({
          method: 'GET',
          url: `https://api.yourservice.com${endpoint}`,
          headers: {
            Authorization: `Bearer ${credentials.apiToken}`,
          },
        });

        returnData.push({ json: response, pairedItem: { item: i } });

      } catch (error) {
        if (this.continueOnFail()) {
          returnData.push({ json: { error: error.message }, pairedItem: { item: i } });
          continue;
        }
        throw new NodeOperationError(this.getNode(), error, { itemIndex: i });
      }
    }

    return [returnData];
  }
}

---

Essential APIs Cheat Sheet#

typescript

// Input
const items = this.getInputData();

// Parameters
this.getNodeParameter('name', i) as string
this.getNodeParameter('count', i, 0) as number
this.getNodeParameter('options', i, {}) as IDataObject

// Credentials
const creds = await this.getCredentials('myCredentialName');

// HTTP
await this.helpers.httpRequest({ method, url, headers, qs, body })

// Error handling
this.continueOnFail()
throw new NodeOperationError(this.getNode(), message, { itemIndex: i })
throw new NodeApiError(this.getNode(), error)   // for API-level HTTP errors

// Output
returnData.push({ json: data, pairedItem: { item: i } })
return [returnData];

---

Pre-Publish Checklist#

• keywords in package.json includes "n8n-community-node-package"
• n8n.nodes and n8n.credentials arrays point to dist/ .js paths
• Node name is camelCase; displayName is human-readable
• Credential name exactly matches string passed to getCredentials('...')
• Every returnData.push() includes pairedItem: { item: i }
• continueOnFail() is handled in all try/catch blocks
• SVG icon exists in nodes/YourService/ and referenced as 'file:yourservice.svg'
• npm run build succeeds (no TypeScript errors)
• npm run lint passes (required for community submission)
• Tested locally via npm link
• Version bumped in package.json before publish