n8n-nodes-clientify 0.2.0 → 0.2.2

package/README.md

@@ -124,52 +124,68 @@ This node dynamically supports **26 operations** from the Clientify MCP API:
 
 ## Trigger Events
 
-**NEW in v0.2.0!** The Clientify Trigger node enables automatic workflow execution when events occur in Clientify CRM.
-
-### Available Triggers
-
-#### 👥 Contact Triggers
-- **Contact Created** - Fires when a new contact is added to Clientify
-- **Contact Updated** - Fires when contact details are modified
-- **Contact Deleted** - Fires when a contact is removed
-
-#### 📊 Company Triggers
-- **Company Created** - Fires when a new company is added to Clientify
-- **Company Updated** - Fires when company details are modified
-- **Company Deleted** - Fires when a company is removed
-
-#### 💼 Deal Triggers
-- **Deal Created** - Fires when a new deal is created
-- **Deal Updated** - Fires when deal details are modified
-- **Deal Won** - Fires when a deal is marked as won
-- **Deal Lost** - Fires when a deal is marked as lost
-- **Deal Stage Changed** - Fires when a deal moves to a different pipeline stage
-- **Deal Deleted** - Fires when a deal is removed
-
-#### ✅ Task Triggers
-- **Task Created** - Fires when a new task is created
-- **Task Completed** - Fires when a task is marked as completed
-- **Task Due Soon** - Fires when a task is approaching its due date
-- **Task Overdue** - Fires when a task passes its due date
-
-### Setting Up Webhooks
-
-1. **Add Clientify Trigger node** to your workflow in n8n
-2. **Select the event** you want to listen for (e.g., "Contact Created")
-3. **Save and activate** the workflow to generate webhook URL
-4. **Copy the webhook URL** from the trigger node
-5. **Configure webhook in Clientify:**
-   - Go to Clientify Settings → Webhooks
-   - Add new webhook
-   - Paste the n8n webhook URL
-   - Select the corresponding event type
-   - Save the webhook configuration
-
-### Webhook Data Structure
-
-When a webhook triggers your workflow, the data is automatically flattened for easy access:
-
-**Contact Created Example:**
+**NEW in v0.2.0!** The Clientify Trigger node enables automatic workflow execution when events occur in Clientify CRM. With 16 event types covering contacts, companies, deals, and tasks, you can automate workflows instantly when things happen in your CRM.
+
+### How It Works
+
+1. Add "Clientify Trigger" node to your n8n workflow
+2. Select which event should start the workflow (e.g., "Contact Created")
+3. Activate the workflow to get your unique webhook URL
+4. Configure the webhook in Clientify to point to your n8n URL
+5. When the event happens in Clientify, your workflow runs automatically with the data
+
+### 16 Available Triggers
+
+| Event | Trigger Name | When It Fires | Common Use Cases |
+|-------|--------------|---------------|------------------|
+| 👥 **Contacts** | | | |
+| | Contact Created | New contact added | Welcome email, create follow-up task, add to CRM |
+| | Contact Updated | Contact details changed | Sync to other systems, log changes, update records |
+| | Contact Deleted | Contact removed | Archive data, remove from email lists, cleanup |
+| 📊 **Companies** | | | |
+| | Company Created | New company added | Research company, assign account manager, notify team |
+| | Company Updated | Company details changed | Update external systems, track changes |
+| | Company Deleted | Company removed | Clean up related data, archive records |
+| 💼 **Deals** | | | |
+| | Deal Created | New deal/opportunity created | Notify sales team, create tasks, log in analytics |
+| | Deal Updated | Deal details changed | Track value changes, update forecasts, log activity |
+| | Deal Won | Deal closed successfully | Send celebration, create invoice, start onboarding |
+| | Deal Lost | Deal closed unsuccessfully | Add to nurture campaign, analyze loss reason |
+| | Deal Stage Changed | Deal moved to different stage | Stage-specific actions (send pricing, generate contract) |
+| | Deal Deleted | Deal removed | Log deletion, archive data |
+| ✅ **Tasks** | | | |
+| | Task Created | New task added | Add to calendar, notify assignee, sync to project tools |
+| | Task Completed | Task marked complete | Log activity, update metrics, trigger next steps |
+| | Task Due Soon | Task approaching due date | Send reminder to assignee |
+| | Task Overdue | Task past due date | Escalate to manager, send urgent notification |
+
+### Setup Instructions
+
+**In n8n:**
+1. Add "Clientify Trigger" node to your workflow
+2. Select the event from the dropdown
+3. Choose your Clientify MCP credentials
+4. Save and **activate** the workflow (toggle ON)
+5. Click the trigger node → Expand "Webhook URLs"
+6. Switch to "Production URL" tab
+7. Copy the webhook URL
+
+**In Clientify:**
+1. Go to Settings → Webhooks
+2. Click "Add Webhook"
+3. Select the matching event (e.g., "contact.created")
+4. Paste your n8n webhook URL
+5. Set status to "Active"
+6. Save
+
+**Test It:**
+Create a contact, deal, or task in Clientify → Check n8n executions → Your workflow should have run!
+
+### Data You'll Receive
+
+All webhook data is automatically flattened so you can easily access it in your workflow. Here's what you get for each event type:
+
+**Contact Events** (`contact.created`, `contact.updated`, `contact.deleted`)
 ```json
 {
   "event": "contact.created",
@@ -180,25 +196,71 @@ When a webhook triggers your workflow, the data is automatically flattened for e
   "email": "john.doe@example.com",
   "phone": "+1234567890",
   "company_id": 456,
-  "company_name": "Acme Corp"
+  "company_name": "Acme Corp",
+  "changes": { /* only for .updated events */ }
 }
 ```
+Access with: `{{$json.first_name}}`, `{{$json.email}}`, `{{$json.company_name}}`
 
-**Deal Won Example:**
+**Company Events** (`company.created`, `company.updated`, `company.deleted`)
+```json
+{
+  "event": "company.created",
+  "timestamp": "2025-10-02T18:00:00Z",
+  "company_id": 999,
+  "name": "Tech Startup Inc",
+  "domain": "techstartup.com",
+  "industry": "Technology",
+  "size": "50-100",
+  "country": "USA"
+}
+```
+Access with: `{{$json.name}}`, `{{$json.domain}}`, `{{$json.industry}}`
+
+**Deal Events** (`deal.created`, `deal.updated`, `deal.won`, `deal.lost`, `deal.stage_changed`, `deal.deleted`)
 ```json
 {
   "event": "deal.won",
-  "timestamp": "2025-10-02T17:00:00Z",
+  "timestamp": "2025-10-02T23:00:00Z",
   "deal_id": 98765,
   "title": "Enterprise License Sale",
-  "value": 50000,
+  "value": 60000,
   "currency": "USD",
   "contact_id": 12345,
   "contact_name": "John Doe",
-  "company_id": 789,
-  "company_name": "New Corp"
+  "company_id": 999,
+  "company_name": "Tech Startup Inc",
+  "stage_name": "Won",
+  "won_at": "2025-10-02T23:00:00Z"
+}
+```
+Access with: `{{$json.title}}`, `{{$json.value}}`, `{{$json.contact_name}}`
+
+**Task Events** (`task.created`, `task.completed`, `task.due_soon`, `task.overdue`)
+```json
+{
+  "event": "task.created",
+  "timestamp": "2025-10-03T03:00:00Z",
+  "task_id": 5555,
+  "title": "Follow up with John Doe",
+  "description": "Discuss pricing options",
+  "type": "call",
+  "contact_id": 12345,
+  "contact_name": "John Doe",
+  "deal_id": 98765,
+  "assigned_to_name": "Sales Rep",
+  "due_date": "2025-10-05"
 }
 ```
+Access with: `{{$json.title}}`, `{{$json.contact_name}}`, `{{$json.due_date}}`
+
+### Important Notes
+
+- **Event names are case-sensitive**: Use exact names like `contact.created` (not `Contact.Created`)
+- **Webhook URLs are unique** per workflow - if you recreate a workflow, you'll get a new URL
+- **Workflows must be active** for webhooks to work - inactive workflows won't receive events
+- **All data includes `_raw`** field with the original payload for advanced use cases
+- **Update events include `changes`** object showing what changed (old/new values)
 
 ## Usage Examples