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
19 resources with 176 operations covering the entire PerfexCRM API.
| Resource | Ops | Operations |
|---|---|---|
| Customer | 10 | Create, Get, Get Many, Update, Delete, Get Contacts, Get Contracts, Get Invoices, Get Projects, Get Tickets |
| Ticket | 14 | Create, Get, Get Many, Update, Delete, Add Reply, Get Reply, Update Reply, Delete Reply, List Replies, Get Attachments, Get History, Assign, Change Status |
| Invoice | 7 | Create, Get, Get Many, Update, Delete, Get Payments, Send |
| Lead | 8 | Create, Get, Get Many, Update, Delete, Convert, Get Activities, Get Notes |
| Project | 9 | Create, Get, Get Many, Update, Delete, Get Activity, Get Files, Get Milestones, Get Tasks |
| Contract | 11 | Create, Get, Get Many, Update, Delete, Sign, Get Attachments, Get Comments, Get Expired, Get Expiring, Renew |
| Task | 22 | Create, Get, Get Many, Update, Delete, Assign, Change Status, Mark Complete, Get Attachments, List Comments, Add Comment, List Timesheets, Add Timesheet, List Checklist, Add Checklist Item, Get Checklist Item, Update Checklist Item, Delete Checklist Item, Change Priority, List Followers, Add Follower, Remove Follower |
| Expense | 6 | Create, Get, Get Many, Update, Delete, Get Categories |
| Estimate | 8 | Create, Get, Get Many, Update, Delete, Send, Convert, Get PDF |
| Staff | 14 | Create, Get, Get Many, Update, Delete, Activate, Deactivate, Get Permissions, Get Departments, Get Roles, Get Department List, Change Password, Get Tasks, Get Timesheets |
| Proposal | 11 | Create, Get, Get Many, Update, Delete, Send, Accept, Decline, List Comments, Add Comment, Get PDF |
| Credit Note | 10 | Create, Get, Get Many, Update, Delete, Add Refund, List Refunds, Apply Credit, List Credits, Get PDF |
| Subscription | 5 | Create, Get, Get Many, Update, Delete |
| Item | 6 | Create, Get, Get Many, Update, Delete, Get Groups |
| Payment | 5 | Create, Get, Get Many, Update, Delete |
| Contact | 5 | Create, Get, Get Many, Update, Delete |
| Timesheet | 5 | Create, Get, Get Many, Update, Delete |
| Note | 5 | Create, Get, Get Many, Update, Delete |
| Utility | 10 | Get Currencies, Get Taxes, Get Departments, Get Payment Modes, Get Countries, Get Ticket Statuses, Get Ticket Priorities, Get Lead Statuses, Get Lead Sources, Get Contract Types |
PerfexCRM Trigger Node
This trigger node listens for webhooks from PerfexCRM and starts workflows when events occur.
Supported Events (80 webhook events)
| Category | Events |
|---|---|
| Contact | created, deleted, updated |
| Contract | cancelled, created, deleted, expired, expiring, signed, updated |
| Credit Note | created, credits_applied, deleted, refund_created, sent, status_changed, updated |
| Customer | contact_added, created, deleted, status_changed, updated |
| Estimate | accepted, converted, created, declined, deleted, expiring, sent, updated |
| Expense | created, deleted, updated |
| Invoice | cancelled, created, deleted, overdue, paid, sent, status_changed, updated |
| Item | created, deleted, updated |
| Lead | assigned, converted, created, status_changed, updated |
| Note | created, deleted, updated |
| Payment | created, deleted, updated |
| Project | completed, created, status_changed, updated |
| Proposal | accepted, comment_added, converted, created, declined, deleted, sent, updated |
| Staff | activated, created, deactivated, deleted, login, password_changed, permissions_changed, updated |
| Subscription | created |
| Task | assigned, comment_added, completed, created, deleted, overdue, priority_changed, status_changed, timesheet_added, updated |
| Ticket | assigned, attachment_added, closed, created, deleted, priority_changed, reopened, reply_added, status_changed, updated |
| Timesheet | created, deleted, 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:
For PerfexCRM API & Webhooks Module:
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 (c) OBS Technologies
Made with care by OBS Technologies
If you find this node useful, please star it on GitHub!