n8n-nodes-linq 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +32 -21
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -19,17 +19,17 @@ Linq Partner API (v2) community node for n8n. This node lets you manage chats, m
19
19
 
20
20
  ## Credentials
21
21
 
22
- Create a new credential of type Linq API and set your Integration Token:
22
+ Create a new credential of type "Linq API" and set your Integration Token:
23
23
 
24
24
  - Header used: `X-LINQ-INTEGRATION-TOKEN: <your token>`
25
25
  - The field is hidden in the UI (password type).
26
26
 
27
- Where its defined:
27
+ Where it's defined:
28
28
  - [class LinqApi implements ICredentialType](credentials/LinqApi.credentials.ts:1)
29
29
 
30
30
  ## Node usage
31
31
 
32
- Add the Linq node to your workflow. The node provides Resources and Operations that map 1:1 to the documented Linq Partner API endpoints.
32
+ Add the "Linq" node to your workflow. The node provides Resources and Operations that map 1:1 to the documented Linq Partner API endpoints.
33
33
 
34
34
  - Node implementation:
35
35
  - [class Linq implements INodeType](nodes/Linq/Linq.node.ts:1)
@@ -61,32 +61,49 @@ The node implements all endpoints from your Linq Partner API documentation (v2):
61
61
  - Resource: Phone Number
62
62
  - Operations:
63
63
  - Get Many → GET `/phone_numbers`
64
- - Check iMessage Availability → POST `/i_message_availability/check` (`phone_number`)
64
+ - Check iMessage Availability → GET `/phone_numbers/:phoneNumber/check_imessage`
65
65
 
66
66
  - Resource: Webhook Subscription
67
67
  - Operations:
68
68
  - Get Many → GET `/webhook_subscriptions`
69
69
  - Get One → GET `/webhook_subscriptions/:id`
70
- - Create → POST `/webhook_subscriptions` (`webhook_url`, `events[]`, `version`, `active`)
71
- - Update → PUT `/webhook_subscriptions/:id` (update any subset of: `webhook_url`, `events[]`, `version`, `active`)
70
+ - Create → POST `/webhook_subscriptions`
71
+ - Update → PUT `/webhook_subscriptions/:id`
72
72
  - Delete → DELETE `/webhook_subscriptions/:id`
73
73
 
74
74
  - Resource: Contact
75
75
  - Operations:
76
- - Create → POST `/contacts` (`contact{ first_name, last_name, email, phone_number, company, title, location }`)
76
+ - Create → POST `/contacts`
77
77
  - Get One → GET `/contacts/:id`
78
- - Update → PUT `/contacts/:id` (any subset of contact fields)
78
+ - Update → PUT `/contacts/:id`
79
79
  - Delete → DELETE `/contacts/:id`
80
80
 
81
- ### Common parameters
81
+ ### Linq Trigger Node
82
82
 
83
- - Pagination (chats): `page`, `perPage`
84
- - Filtering (chats, find): `phoneNumber`
85
- - IDs: `chatId`, `chatMessageId`, `contactId`, `webhookSubscriptionId`
83
+ Add the "Linq Trigger" node to automatically start workflows when Linq events occur. The node automatically registers a webhook with Linq when the workflow is activated.
86
84
 
87
- ## Examples
85
+ - Supported Events:
86
+ - Message Sent (`message.sent`)
87
+ - Message Received (`message.received`)
88
+ - Message Read (`message.read`)
89
+ - Call Completed (`call.completed`)
90
+ - Contact Created (`contact.created`)
91
+ - Contact Updated (`contact.updated`)
92
+ - Contact Deleted (`contact.deleted`)
88
93
 
89
- 1) Create a chat and send an initial message
94
+ - Configuration:
95
+ 1. Add the "Linq Trigger" node to your workflow
96
+ 2. Select which events should trigger the workflow
97
+ 3. Activate the workflow (this registers the webhook with Linq)
98
+ 4. Linq will send events to your workflow when they occur
99
+
100
+ - Security:
101
+ - The node verifies the signature of incoming events using HMAC-SHA256
102
+ - Requires the same Linq API credentials as the main node
103
+
104
+ ### Example workflows
105
+
106
+ 1) Send a group message
90
107
  - Resource: Chat
91
108
  - Operation: Create
92
109
  - Fields:
@@ -140,7 +157,7 @@ Local link for testing in a local n8n:
140
157
  npm link
141
158
  # in your n8n folder
142
159
  npm link n8n-nodes-linq
143
- # restart n8n, then add Linq node
160
+ # restart n8n, then add "Linq" node
144
161
  ```
145
162
 
146
163
  Project files of interest:
@@ -174,9 +191,3 @@ npm publish --access public
174
191
  - Node description references it as `icon: 'file:linq.svg'`, so it renders in the n8n UI.
175
192
 
176
193
  ## License
177
-
178
- MIT — see [LICENSE.md](LICENSE.md:1)
179
-
180
- ## Support
181
-
182
- Issues and suggestions are welcome. Please open an issue in your repository once you push the source (see `repository` field in [package.json](package.json:1)).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "n8n-nodes-linq",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "Linq API integration for n8n",
5
5
  "keywords": [
6
6
  "n8n-community-node-package",