n8n Klipy Node

This is an n8n community node for integrating with the Klipy CRM API. It provides comprehensive access to all Klipy API endpoints including authentication, people management, company management, and interaction tracking.

Features

• Full CRM Integration: Access to all Klipy API endpoints
• AI Agent Support: Can be used as a tool in n8n AI Agent workflows
• Comprehensive Operations: Create, read, update, delete, and query operations for all resources
• Flexible Filtering: Advanced query capabilities with filtering and pagination

AI Agent Support

This node supports n8n's AI Agent functionality and can be used as a tool in AI Agent workflows. When added as a tool, the AI Agent can:

• Manage Contacts: Create, update, and query person records
• Handle Companies: Manage company information and relationships
• Track Interactions: Log and retrieve interaction history
• Authenticate: Verify API credentials and get team information

To use this node as an AI tool:

1. Add an AI Agent node to your workflow
2. Click on the "Tools" section
3. Add the Klipy tool from the available tools list
4. Configure the credentials and parameters as needed

Installation

Follow the installation guide for n8n community nodes.

Install locally

For development, clone this repository and run:

npm install
npm run build

Install globally

npm install -g n8n-nodes-klipy

Credentials

To use this node, you need to create a Klipy API credential:

1. API Key: Your Klipy API key (required)
2. Base URL: The base URL for the Klipy API (defaults to https://api.klipycrm.com/api/v1)

You can get your API key from the Klipy Developer Portal.

Resources and Operations

Auth

• Test API Key: Verify your API key is valid and get team information

Person

• Get: Retrieve a person by ID
• Get All: Query all people records
• Create: Create a new person record
• Update: Update an existing person record
• Delete: Delete a person record
• Upsert: Create or update a person record

Company

• Get: Retrieve a company by ID
• Get All: Query all company records
• Create: Create a new company record
• Update: Update an existing company record
• Delete: Delete a company record

Interaction

• Get: Retrieve an interaction by ID
• Get All: Query all interaction records
• Create: Create a new interaction record

Usage Examples

Test API Key

Use the Auth resource with "Test API Key" operation to verify your credentials. This will return your team name if successful.

Create a Person

1. Select "Person" as the resource
2. Choose "Create" as the operation
3. Fill in the person data:
   • First Name
   • Last Name
   • Email
   • Phone (optional)
   • Company (optional)
   • Title (optional)

Create a Company

1. Select "Company" as the resource
2. Choose "Create" as the operation
3. Fill in the company data:
   • Name (required)
   • Website (optional)
   • Industry (optional)

Create an Interaction

1. Select "Interaction" as the resource
2. Choose "Create" as the operation
3. Fill in the interaction data:
   • Type (email, call, meeting, or note)
   • Subject
   • Content
   • Person ID (optional)
   • Company ID (optional)

API Reference

This node implements the following Klipy API endpoints:

• GET /authenticate - Test API key
• GET /people/{id} - Get person by ID
• POST /people/query - Query people records
• POST /people - Create person
• PATCH /people/{id} - Update person
• DELETE /people/{id} - Delete person
• PUT /people - Upsert person
• GET /companies/{id} - Get company by ID
• POST /companies/query - Query company records
• POST /companies - Create company
• PATCH /companies/{id} - Update company
• DELETE /companies/{id} - Delete company
• GET /interactions/{id} - Get interaction by ID
• POST /interactions/query - Query interaction records
• POST /interactions - Create interaction

For detailed API documentation, visit the Klipy API Reference.

Development

Building

npm run build

Development mode

npm run dev

Linting

npm run lint
npm run lintfix

License

MIT

Support

For issues and questions:

• Create an issue in this repository
• Check the Klipy API documentation
• Visit the n8n community forum