personio

n8n community node for Personio HR integration

Package Information

Downloads: 1 weekly / 11 monthly
Latest Version: 0.1.0
Author: Richard Keil

Documentation

@plancraft/n8n-nodes-personio

An n8n community node for Personio HR integration.

Features

  • Personio Trigger: Webhook-based trigger for Personio events
    • Employee Created
    • Employee Updated
    • Employee Deleted

Installation

In n8n

Follow the n8n community nodes installation guide.

# Using npm
npm install @plancraft/n8n-nodes-personio

# Using pnpm
pnpm add @plancraft/n8n-nodes-personio

For Development

# Clone the repository
git clone <repo-url>
cd n8n-personio

# Install dependencies
pnpm install

# Build the project
pnpm build

# Link to your local n8n
pnpm link --global

Configuration

Credentials

  1. In n8n, go to CredentialsAdd Credential
  2. Search for "Personio API"
  3. Enter your Personio API credentials:
    • Client ID: Your Personio API client ID
    • Client Secret: Your Personio API client secret

Get your API credentials from the Personio Developer Portal.

Development

Commands

Command Description
pnpm build Compile TypeScript and copy assets
pnpm dev Watch mode for development
pnpm test Run tests
pnpm test:watch Run tests in watch mode
pnpm test:coverage Run tests with coverage
pnpm lint Check for linting errors
pnpm lint:fix Fix linting errors
pnpm typecheck Type-check without emitting
pnpm format Format code with Prettier
pnpm clean Remove dist folder

Project Structure

├── credentials/
│   └── PersonioApi.credentials.ts    # API credential definition
├── nodes/
│   └── Personio/
│       ├── PersonioTrigger.node.ts   # Trigger node implementation
│       ├── PersonioTrigger.test.ts   # Tests
│       └── personio.svg              # Node icon
├── Makefile                          # Build commands
├── dist/                             # Compiled output (git-ignored)
├── tsconfig.json                     # TypeScript config (production)
├── tsconfig.test.json                # TypeScript config (tests)
├── vitest.config.ts                  # Test configuration
└── package.json

Testing in n8n

  1. Build the node: make build
  2. Link to your local n8n instance: make locale-install
  3. Restart n8n

License

MIT

Discussion