n8n-nodes-hamkar 3.0.12 → 3.1.1

package/README.md

@@ -1,15 +1,24 @@
 # n8n-nodes-hamkar
 
-This is an n8n community node for integrating with the Hamkar.co API. It allows you to manage contacts and records (create, update, delete, and list) through n8n workflows.
+This is an n8n community node for integrating with the Hamkar.co API. It allows you to manage contacts and records (create, update, delete, and list) through n8n workflows, plus automatic workflow triggers.
 
 [n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
 
-[Installation](#installation)  
-[Operations](#operations)  
-[Credentials](#credentials)  
-[Compatibility](#compatibility)  
-[Usage](#usage)  
-[Resources](#resources)  
+## 📚 Documentation
+
+- **[Complete Documentation](DOCUMENTATION.md)** - Full guide with examples and best practices
+- **[Quick Reference](QUICK_REFERENCE.md)** - Cheat sheet for common operations
+- **[Troubleshooting Guide](TROUBLESHOOTING_GUIDE.md)** - Solutions to common issues
+
+## 📑 Quick Links
+
+- [Installation](#installation)  
+- [Operations](#operations)  
+- [Credentials](#credentials)  
+- [Trigger Node](#trigger-node)
+- [Example Workflows](#example-workflows)  
+- [Compatibility](#compatibility)  
+- [Resources](#resources)  
 
 ## Installation
 
@@ -29,20 +38,38 @@ After installing the node, you can use it like any other node. n8n displays the
 
 ## Operations
 
-The Hamkar node supports the following operations:
+The Hamkar package includes two nodes:
 
-### Contact
+### 1. Hamkar Node (Regular Operations)
+
+#### Contact Operations
 - **Create**: Create a new contact with name, phone numbers, address, and type (legal/natural)
 - **Update**: Update an existing contact by ID
 - **Delete**: Delete a contact by ID (or archive using update)
 - **Get Many**: Retrieve multiple contacts with optional search filtering
 
-### Record
+#### Record Operations
 - **Create**: Create a new record with contact information, products, and custom field answers
 - **Update**: Update an existing record by ID
 - **Delete**: Delete a record by ID
 - **Get Many**: Retrieve multiple records with optional search filtering
 
+### 2. Hamkar Trigger Node (Automatic Workflow Starts)
+
+Automatically triggers workflows when events occur in Hamkar:
+
+#### Contact Triggers
+- **Contact Created**: Triggers when a new contact is created
+- **Contact Updated**: Triggers when a contact is modified
+- **Contact Deleted**: Triggers when a contact is deleted
+
+#### Record Triggers
+- **Record Created**: Triggers when a new record is created
+- **Record Updated**: Triggers when a record is modified
+- **Record Deleted**: Triggers when a record is deleted
+
+**Note**: Trigger functionality requires webhook support from Hamkar.co. If webhooks are not available, use scheduled polling with "Get Many" operations instead.
+
 ## Credentials
 
 To use this node, you need a Hamkar API key:
@@ -99,16 +126,101 @@ You can:
 - Return all records or limit the number
 - Use a search query to filter results
 
-## Example Workflow
+## Trigger Node
+
+### Setup Webhook Triggers
+
+1. **In n8n:**
+   - Add "Hamkar Trigger" node to your workflow
+   - Select the event you want to listen for
+   - Copy the webhook URL provided
+
+2. **In Hamkar.co:**
+   - Navigate to Settings → Webhooks (if available)
+   - Add the webhook URL from n8n
+   - Select which events to send
+   - Save configuration
+
+3. **Activate Workflow:**
+   - Toggle your workflow to "Active"
+   - Test by creating/updating a contact or record in Hamkar
+
+### Alternative: Polling Method
+
+If Hamkar.co doesn't support webhooks yet, use scheduled polling:
+
+```
+[Schedule Trigger] (every 5 minutes)
+   ↓
+[Hamkar - Get Many Contacts]
+   ↓
+[Function Node] (compare with previous results)
+   ↓
+[Process new/changed items]
+```
+
+## Example Workflows
+
+### 1. Create Contact from Form Submission
+
+```
+[Webhook Trigger] (Form submission)
+   ↓
+[Hamkar - Create Contact]
+   Name: {{$json.name}}
+   Phone: {{$json.phone}}
+   ↓
+[Send Email] (Confirmation)
+```
+
+### 2. Auto-Email New Contacts
 
-Here's a simple example workflow:
+```
+[Hamkar Trigger] (Contact Created)
+   ↓
+[Send Email]
+   To: sales@company.com
+   Subject: New Contact: {{$json.name}}
+   Body: Phone: {{$json.phone_number}}
+```
+
+### 3. Daily Contact Report
+
+```
+[Schedule Trigger] (Daily at 9 AM)
+   ↓
+[Hamkar - Get Many Contacts]
+   Return All: true
+   ↓
+[Function Node] (Calculate statistics)
+   ↓
+[Send Email] (Report to manager)
+```
+
+### 4. Import Contacts from CSV
+
+```
+[Read CSV File]
+   ↓
+[Split In Batches] (10 contacts per batch)
+   ↓
+[Hamkar - Create Contact]
+   Name: {{$json.name}}
+   Phone: {{$json.phone}}
+   ↓
+[Wait] (1 second between batches)
+```
+
+### 5. Sync to Google Sheets
+
+```
+[Hamkar Trigger] (Contact Created/Updated)
+   ↓
+[Google Sheets - Append/Update Row]
+   Values: {{$json.name}}, {{$json.phone_number}}
+```
 
-1. **Trigger**: Webhook or Schedule
-2. **Hamkar Node**: Create a new record
-   - Set credentials
-   - Configure record details
-   - Add products and answers
-3. **Process**: Use the returned data in subsequent nodes
+For more examples and detailed guides, see [DOCUMENTATION.md](DOCUMENTATION.md).
 
 ## Resources
 
@@ -140,5 +252,38 @@ npm run dev
 
 ## Support
 
-For issues, questions, or contributions, please open an issue on [GitHub](https://github.com/yourusername/n8n-nodes-hamkar/issues).
+### Documentation
+
+Before asking for help, check these resources:
+
+1. **[Complete Documentation](DOCUMENTATION.md)** - Comprehensive guide with all features
+2. **[Quick Reference](QUICK_REFERENCE.md)** - Quick lookup for common tasks
+3. **[Troubleshooting Guide](TROUBLESHOOTING_GUIDE.md)** - Solutions to common problems
+
+### Getting Help
+
+- **Issues & Bugs**: [GitHub Issues](https://github.com/yourusername/n8n-nodes-hamkar/issues)
+- **Questions**: [n8n Community Forum](https://community.n8n.io/)
+- **Feature Requests**: [GitHub Issues](https://github.com/yourusername/n8n-nodes-hamkar/issues) with "enhancement" label
+
+### Reporting Bugs
+
+When reporting an issue, please include:
+- n8n version
+- Node package version
+- Error message (full text)
+- Steps to reproduce
+- Expected vs actual behavior
+
+## Version History
+
+See [CHANGELOG.md](CHANGELOG.md) for version history and updates.
+
+**Current Version**: 3.0.12
+
+### Recent Updates
+- ✅ Added Hamkar Trigger node for automatic workflows
+- ✅ Support for Contact and Record events
+- ✅ Improved icon and UI elements
+- ✅ Comprehensive documentation and guides
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-hamkar",
-  "version": "3.0.12",
+  "version": "3.1.1",
   "description": "n8n node for Hamkar.co API - Contact and Record management operations",
   "keywords": [
     "n8n-community-node-package",