Package Information
Documentation
n8n-nodes-perfexcrm
This is an n8n community node. It lets you use PerfexCRM in your n8n workflows.
PerfexCRM is a powerful customer relationship management system. This node allows you to interact with the PerfexCRM API and receive webhooks for real-time events.
n8n is a fair-code licensed workflow automation platform.
š Prerequisites - PerfexCRM API & Webhooks Module
This n8n node requires the PerfexCRM API & Webhooks module to be installed on your PerfexCRM instance.
š Purchase the PerfexCRM API & Webhooks Module at perfexapi.com
The module provides:
- RESTful API endpoints for all PerfexCRM entities
- Webhook support for real-time events
- API key authentication
- Rate limiting and security features
- Comprehensive documentation
Installation
Follow the installation guide in the n8n community nodes documentation.
Manual Installation
- Clone or download this repository
- In your n8n installation folder, navigate to
~/.n8n/nodes/ - Create a folder called
n8n-nodes-perfexcrm - Copy all files from this repository into that folder
- Build the node:
cd ~/.n8n/nodes/n8n-nodes-perfexcrm npm install npm run build - Restart n8n
Operations
PerfexCRM Node
This node allows you to perform CRUD operations on various PerfexCRM resources:
Customers
- Create a new customer
- Get a customer by ID
- Get all customers with filters
- Update a customer
- Delete a customer
Tickets
- Create a new ticket
- Get a ticket by ID
- Get all tickets with filters
- Update a ticket
- Delete a ticket
- Add a reply to a ticket
Invoices
- Create a new invoice
- Get an invoice by ID
- Get all invoices with filters
Leads
- Create a new lead
- Get a lead by ID
- Convert a lead to customer
Projects
- Create a new project
- Get a project by ID
Contracts
- Create a new contract
- Get a contract by ID
PerfexCRM Trigger Node
This trigger node listens for webhooks from PerfexCRM and starts workflows when events occur:
Supported Events
- Customer events (created, updated, deleted)
- Contact events (created, updated, deleted)
- Lead events (created, updated, converted, deleted)
- Invoice events (created, updated, paid, overdue, deleted)
- Payment events (recorded, failed)
- Proposal events (created, sent, accepted, declined)
- Estimate events (created, sent, accepted, declined, converted)
- Contract events (created, signed, expiring, expired)
- Project events (created, updated, completed)
- Task events (created, updated, completed, comment added)
- Ticket events (created, updated, status changed, reply added, assigned, closed)
- Staff events (created, login)
- Expense events (created, updated)
Credentials
You'll need to enter the following credentials to use this node:
- Base URL: The URL of your PerfexCRM installation (e.g.,
https://your-perfex.com) - API Key: Your PerfexCRM API key (starts with
pk_) - API Version: The API version to use (currently only
v1is supported)
Getting your API Key
- Log in to your PerfexCRM admin panel
- Navigate to Setup ā API & Webhooks
- Click on API Keys
- Create a new API key with the appropriate permissions
- Copy the API key (you'll only see it once!)
Example Workflows
šÆ Lead to Customer Automation
Automatically convert leads to customers when they meet certain criteria, create a project, and send a welcome email.
š° Invoice Payment Tracking
Track invoice payments in real-time, update your accounting system, and notify your team.
š« Support Ticket Routing
Automatically assign tickets based on department, priority, or customer type, and send notifications to the right team members.
š Customer Onboarding
Create a complete onboarding workflow: create customer, setup project, generate first invoice, and send welcome materials.
Compatibility
- ā n8n version 0.180.0 or later
- ā PerfexCRM 2.3.x or later
- ā PerfexCRM API & Webhooks Module (required)
Resources
- š Purchase PerfexCRM API & Webhooks Module
- š n8n Community Nodes Documentation
- š PerfexCRM API Documentation
- š§ GitHub Repository
- š¦ npm Package
Support
For n8n Node Issues:
- š Open an issue on GitHub
- š¬ n8n Community Forum
For PerfexCRM API & Webhooks Module:
- š Support at perfexapi.com
- š§ Email: support@obstechnologies.com
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Author
OBS Technologies
- Website: obstechnologies.com
- PerfexCRM Modules: perfexapi.com
- GitHub: @OBSTechnologies
License
MIT Ā© OBS Technologies
Made with ā¤ļø by OBS Technologies
ā If you find this node useful, please star it on GitHub!