n8n-nodes-olli

Custom n8n nodes for interacting with the Olli API. Olli is a Total Talent HR application with ATS and VMS modules.

Installation

Via npm (aanbevolen voor productie)

Installeer het package via npm in je n8n omgeving:

npm install n8n-nodes-olli

Na installatie, herstart n8n om de nodes te laden.

Voor Docker/n8n Cloud:

• Voeg N8N_COMMUNITY_PACKAGES_ENABLED=true toe aan je environment variabelen
• Installeer het package in de container of via de n8n interface

Handmatige installatie (development)

1. Copy this directory to your n8n custom nodes directory:

   cp -r n8n-nodes-olli ~/.n8n/custom/nodes/

2. Navigate to the custom nodes directory:

   cd ~/.n8n/custom/nodes/n8n-nodes-olli

3. Install dependencies:

   npm install

4. Build the nodes:

   npm run build

5. Restart n8n to load the custom nodes.

Configuration

Credentials Setup

1. In n8n, go to Credentials → Add Credential
2. Search for Olli API and select it
3. Fill in the following fields:
   • Base URL: The base URL of your Olli installation (e.g., http://localhost or https://olli.example.com)
   • API Key: Your Olli API key (required)
   • Access Token: Optional access token for endpoints that require Bearer token authentication

Available Nodes

Olli HTTP

A generic HTTP node for making flexible API calls to any Olli endpoint.

Features:

• Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE)
• Dynamic endpoint configuration
• Query parameter support
• JSON body support for POST/PUT/PATCH requests
• Configurable timeout

Example Usage:

• Method: GET
• Endpoint: /api/v1/candidate/123
• Query Parameters: status=active&limit=10

Olli Candidate

A dedicated node for candidate operations.

Operations:

• Get: Retrieve a candidate by ID
• List: List all candidates
• Create: Create a new candidate
• Update: Update an existing candidate
• Delete: Delete a candidate

Required Fields for Create:

• First Name
• Last Name
• Email
• Phone Cell
• Candidate Status ID

Additional Fields:

• Middle Name, Title, Email 2
• Address fields (Street, Number, City, State, Zipcode, Country)
• Phone numbers (Home, Work)
• LinkedIn URL
• Notes

Olli Job Order

A dedicated node for job order operations.

Operations:

• Get: Retrieve a job order by ID
• List: List job orders by portal ID
• Create: Create a new job order
• Update: Update an existing job order

Required Fields for Create:

• Title
• Description

Additional Fields:

• Teaser
• Address fields
• Salary information
• Hours, Openings
• Start Date
• Notes

API Endpoint Pattern

The Olli API follows this pattern:

• Base URL: /api/v1/
• Controllers: camelCase (e.g., candidate → CandidateApiController)
• Actions: HTTP method + camelCase (e.g., GET /candidate/1 → getIndex action)

Authentication

The nodes support two authentication methods:

1. API Key (required): Sent via API-KEY header
2. Access Token (optional): Sent via Authorization: Bearer {token} header

Both are configured in the Olli API credentials.

Example Workflows

Create a Candidate

1. Add Olli Candidate node
2. Select Create operation
3. Fill in required fields (First Name, Last Name, Email, Phone Cell, Candidate Status ID)
4. Add any additional fields as needed
5. Connect to your Olli API credentials
6. Execute the workflow

List Job Orders

1. Add Olli Job Order node
2. Select List operation
3. Enter the Portal ID
4. Connect to your Olli API credentials
5. Execute the workflow

Custom API Call

1. Add Olli HTTP node
2. Select HTTP method (e.g., GET)
3. Enter endpoint (e.g., /api/v1/company)
4. Add query parameters if needed
5. Connect to your Olli API credentials
6. Execute the workflow

Error Handling

All nodes support error handling via the "Continue on Fail" option. When enabled, errors will be returned in the output JSON with an error field instead of stopping the workflow.

Development

Building

npm run build

Linting

npm run lint

Formatting

npm run format

Troubleshooting

Nodes not appearing in n8n

1. Ensure the nodes are built: npm run build
2. Check that the files are in the correct location: ~/.n8n/custom/nodes/n8n-nodes-olli/dist/
3. Restart n8n completely

Authentication errors

1. Verify your API key is correct
2. Check that the base URL is correct (no trailing slash)
3. For endpoints requiring access tokens, ensure the token is configured

API errors

• Check the error message in the node output
• Verify the endpoint path is correct
• Ensure required fields are provided for create/update operations
• Check Olli API logs for detailed error information

License

MIT