@firetell/n8n-nodes-firetell 0.0.0-stage → 1.0.1

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 (49) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/LICENSE +21 -0
  3. package/README.md +83 -2
  4. package/dist/credentials/FiretellApi.credentials.d.ts +9 -0
  5. package/dist/credentials/FiretellApi.credentials.js +46 -0
  6. package/dist/credentials/FiretellApi.credentials.js.map +1 -0
  7. package/dist/nodes/Firetell/Firetell.node.d.ts +15 -0
  8. package/dist/nodes/Firetell/Firetell.node.js +509 -0
  9. package/dist/nodes/Firetell/Firetell.node.js.map +1 -0
  10. package/dist/nodes/Firetell/Firetell.node.json +19 -0
  11. package/dist/nodes/Firetell/FiretellTrigger.node.d.ts +16 -0
  12. package/dist/nodes/Firetell/FiretellTrigger.node.js +302 -0
  13. package/dist/nodes/Firetell/FiretellTrigger.node.js.map +1 -0
  14. package/dist/nodes/Firetell/FiretellTrigger.node.json +19 -0
  15. package/dist/nodes/Firetell/GenericFunctions.d.ts +12 -0
  16. package/dist/nodes/Firetell/GenericFunctions.js +129 -0
  17. package/dist/nodes/Firetell/GenericFunctions.js.map +1 -0
  18. package/dist/nodes/Firetell/descriptions/AddressBookDescription.d.ts +3 -0
  19. package/dist/nodes/Firetell/descriptions/AddressBookDescription.js +131 -0
  20. package/dist/nodes/Firetell/descriptions/AddressBookDescription.js.map +1 -0
  21. package/dist/nodes/Firetell/descriptions/AgentDescription.d.ts +3 -0
  22. package/dist/nodes/Firetell/descriptions/AgentDescription.js +133 -0
  23. package/dist/nodes/Firetell/descriptions/AgentDescription.js.map +1 -0
  24. package/dist/nodes/Firetell/descriptions/CallDescription.d.ts +3 -0
  25. package/dist/nodes/Firetell/descriptions/CallDescription.js +224 -0
  26. package/dist/nodes/Firetell/descriptions/CallDescription.js.map +1 -0
  27. package/dist/nodes/Firetell/descriptions/ContactDescription.d.ts +3 -0
  28. package/dist/nodes/Firetell/descriptions/ContactDescription.js +198 -0
  29. package/dist/nodes/Firetell/descriptions/ContactDescription.js.map +1 -0
  30. package/dist/nodes/Firetell/descriptions/KnowledgeBaseDescription.d.ts +3 -0
  31. package/dist/nodes/Firetell/descriptions/KnowledgeBaseDescription.js +160 -0
  32. package/dist/nodes/Firetell/descriptions/KnowledgeBaseDescription.js.map +1 -0
  33. package/dist/nodes/Firetell/descriptions/MessageDescription.d.ts +3 -0
  34. package/dist/nodes/Firetell/descriptions/MessageDescription.js +199 -0
  35. package/dist/nodes/Firetell/descriptions/MessageDescription.js.map +1 -0
  36. package/dist/nodes/Firetell/descriptions/PhoneNumberDescription.d.ts +3 -0
  37. package/dist/nodes/Firetell/descriptions/PhoneNumberDescription.js +106 -0
  38. package/dist/nodes/Firetell/descriptions/PhoneNumberDescription.js.map +1 -0
  39. package/dist/nodes/Firetell/descriptions/TeamDescription.d.ts +3 -0
  40. package/dist/nodes/Firetell/descriptions/TeamDescription.js +87 -0
  41. package/dist/nodes/Firetell/descriptions/TeamDescription.js.map +1 -0
  42. package/dist/nodes/Firetell/descriptions/VoiceAgentDescription.d.ts +3 -0
  43. package/dist/nodes/Firetell/descriptions/VoiceAgentDescription.js +223 -0
  44. package/dist/nodes/Firetell/descriptions/VoiceAgentDescription.js.map +1 -0
  45. package/dist/nodes/Firetell/descriptions/index.d.ts +9 -0
  46. package/dist/nodes/Firetell/descriptions/index.js +31 -0
  47. package/dist/nodes/Firetell/descriptions/index.js.map +1 -0
  48. package/dist/nodes/Firetell/firetell.svg +13 -0
  49. package/package.json +70 -4
package/CHANGELOG.md ADDED
@@ -0,0 +1,20 @@
1
+ # Changelog
2
+
3
+ All notable changes to `@firetell/n8n-nodes-firetell` will be documented in this file.
4
+
5
+ ## [1.0.1] - 2026-11-19
6
+
7
+ ### Fixed
8
+ - **FiretellTrigger signature verification & Test vs. Production mode**:
9
+ - Separated `workflowStaticData` keys (`webhookId_test`/`webhookSecret_test` vs. `webhookId_prod`/`webhookSecret_prod`) so Test mode ("Listen for Test Event") and Production mode no longer overwrite or delete each other's webhook subscriptions.
10
+ - Added an in-memory URL-keyed secret fallback cache for manual Test runs where n8n does not persist `workflowStaticData`.
11
+ - In `checkExists`, automatically recreate the Firetell webhook if `verifySignature` is enabled and no signing secret is stored (since `GET /api/v1/webhooks/:id` omits `secret`).
12
+ - Added fallback HMAC-SHA256 verification against `JSON.stringify(body)` when `req.rawBody` is missing or empty, plus clearer `401` diagnostic messages.
13
+
14
+ ## [1.0.0] - 2026-11-19
15
+
16
+ ### Added
17
+ - Initial release of `@firetell/n8n-nodes-firetell` (MIT license).
18
+ - `FiretellApi` credential with Workspace Domain + API Secret Key (`Authorization: ApiKey <secretKey>`) and built-in connection test.
19
+ - `FiretellTrigger` node with automatic Firetell webhook lifecycle management (`checkExists`, `create`, `delete`), all 18 Firetell webhook events, and HMAC-SHA256 `X-Webhook-Signature` verification.
20
+ - `Firetell` action node (`usableAsTool: true`) with dynamic `loadOptions` and 9 resources: Call, Message (SMS/MMS), Contact, Address Book, Voice AI Agent, Knowledge Base (including binary document upload & URL crawling), Phone Number, Agent, and Team.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Firetell
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,84 @@
1
- # Temporary Holding Version
1
+ # @firetell/n8n-nodes-firetell
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Official **n8n community nodes** for [Firetell](https://firetell.com) — automate programmable voice calls, SMS/MMS messaging, Voice AI agents, Knowledge Bases (RAG), contacts, and real-time webhook triggers with built-in **HMAC-SHA256 signature verification**.
4
+
5
+ - **Zero runtime dependencies** (uses native n8n HTTP helpers and `node:crypto`)
6
+ - **AI Agent Tool compatible** (`usableAsTool: true`) — let n8n AI Agents place calls, send SMS, or lookup contacts
7
+ - **Auto-managed Firetell Trigger** — automatically registers/updates/deletes webhook subscriptions in your Firetell workspace and verifies `X-Webhook-Signature`
8
+ - **Dynamic dropdowns** — auto-loads Phone Numbers, Voice AI Agents, Knowledge Bases, Address Books, Agents, and Teams
9
+
10
+ ---
11
+
12
+ ## Installation
13
+
14
+ ### In n8n UI (Recommended)
15
+
16
+ 1. Open your n8n instance and go to **Settings → Community Nodes**.
17
+ 2. Click **Install**.
18
+ 3. Enter `@firetell/n8n-nodes-firetell` and confirm.
19
+
20
+ ### Manual Installation
21
+
22
+ ```bash
23
+ npm install @firetell/n8n-nodes-firetell
24
+ ```
25
+
26
+ ---
27
+
28
+ ## Credentials Setup (`Firetell API`)
29
+
30
+ 1. In Firetell Console, generate an **API Secret Key** (`sk-...`).
31
+ 2. In n8n, create a new **Firetell API** credential with:
32
+ - **Workspace Domain:** e.g. `yourcompany.firetell.app`
33
+ - **API Secret Key:** `sk-...`
34
+ 3. Click **Test** to verify connectivity (`GET /api/v1` with `Authorization: ApiKey <secretKey>`).
35
+
36
+ ---
37
+
38
+ ## Nodes Included
39
+
40
+ ### 1. Firetell Trigger (`FiretellTrigger`)
41
+
42
+ Starts an n8n workflow whenever selected Firetell events occur.
43
+
44
+ - **Auto-Managed Webhooks:** Activating a workflow registers the n8n webhook URL in Firetell (`POST /api/v1/webhooks`) and stores the signing secret. Deactivating automatically removes it (`DELETE /api/v1/webhooks/{id}`).
45
+ - **HMAC-SHA256 Verification:** Enabled by default (`Verify Webhook Signature = true`). Validates the `X-Webhook-Signature` header using constant-time `crypto.timingSafeEqual` against the raw request body and rejects unauthorized requests with HTTP `401`.
46
+ - **Supported Events (18):**
47
+ - **Calls:** `call.created`, `call.answered`, `call.ended`, `call.recording.ready`, `call.transcription.completed`, `call.transcription.summary`
48
+ - **Messages:** `message.received`, `message.sent`, `message.delivered`, `message.failed`, `message.undelivered`
49
+ - **Contacts:** `contact.created`, `contact.updated`, `contact.deleted`
50
+ - **Agents:** `agent.created`, `agent.updated`, `agent.deleted`
51
+ - **Workspace:** `workspace.credit.updated`
52
+
53
+ ### 2. Firetell (`Firetell`)
54
+
55
+ Action node supporting 9 resources (usable as an n8n AI Agent Tool):
56
+
57
+ | Resource | Operations |
58
+ | :--- | :--- |
59
+ | **Call** | `Make Call`, `Send Actions`, `Get Many`, `Get Events`, `Get Recordings`, `Get Transcription` |
60
+ | **Message (SMS/MMS)** | `Send`, `Get`, `Get Many` |
61
+ | **Contact** | `Lookup by Phone`, `Create`, `Get`, `Get Many`, `Update`, `Delete` |
62
+ | **Address Book** | `Create`, `Get`, `Get Many`, `Update`, `Delete` |
63
+ | **Voice AI Agent** | `Get Many`, `Get`, `Create`, `Update`, `Update Settings`, `Publish Version` |
64
+ | **Knowledge Base** | `Get Many`, `Get`, `Create`, `Upload Document` *(binary)*, `Crawl URLs`, `Recrawl Document`, `Delete Document` |
65
+ | **Phone Number** | `Get Many`, `Get`, `Update` |
66
+ | **Agent** | `Get Many`, `Get`, `Create`, `Update`, `Delete` |
67
+ | **Team** | `Get Many`, `Get`, `Create`, `Update`, `Delete`, `Add Agent`, `Remove Agent` |
68
+
69
+ ---
70
+
71
+ ## Documentation & References
72
+
73
+ - **Workspace API Reference:** https://firetell.com/docs/developers/rest-api/overview
74
+ - **Quickstart:** https://firetell.com/docs/developers/getting-started/quickstart
75
+ - **Authentication:** https://firetell.com/docs/developers/getting-started/authentication
76
+ - **Webhooks:** https://firetell.com/docs/developers/rest-api/workspace-api/webhooks
77
+ - **SDKs Overview:** https://firetell.com/docs/developers/sdks/overview
78
+ - **OpenAPI Playground:** https://firetell.com/docs/developers/api-playground/workspace-api
79
+
80
+ ---
81
+
82
+ ## License
83
+
84
+ MIT © [Firetell](https://github.com/firetellcom/firetell-n8n-nodes/blob/main/LICENSE)
@@ -0,0 +1,9 @@
1
+ import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
2
+ export declare class FiretellApi implements ICredentialType {
3
+ name: string;
4
+ displayName: string;
5
+ documentationUrl: string;
6
+ properties: INodeProperties[];
7
+ authenticate: IAuthenticateGeneric;
8
+ test: ICredentialTestRequest;
9
+ }
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.FiretellApi = void 0;
4
+ class FiretellApi {
5
+ name = 'firetellApi';
6
+ displayName = 'Firetell API';
7
+ documentationUrl = 'https://firetell.com/docs/developers/getting-started/authentication';
8
+ properties = [
9
+ {
10
+ displayName: 'Workspace Domain',
11
+ name: 'domain',
12
+ type: 'string',
13
+ default: '',
14
+ required: true,
15
+ placeholder: 'yourcompany.firetell.app',
16
+ description: 'Your Firetell workspace domain (e.g. yourcompany.firetell.app or https://yourcompany.firetell.app)',
17
+ },
18
+ {
19
+ displayName: 'API Secret Key',
20
+ name: 'secretKey',
21
+ type: 'string',
22
+ typeOptions: { password: true },
23
+ default: '',
24
+ required: true,
25
+ placeholder: 'sk-...',
26
+ description: 'Workspace API Secret Key generated in Firetell Console (sent as Authorization: ApiKey <secretKey>)',
27
+ },
28
+ ];
29
+ authenticate = {
30
+ type: 'generic',
31
+ properties: {
32
+ headers: {
33
+ Authorization: '=ApiKey {{$credentials.secretKey}}',
34
+ },
35
+ },
36
+ };
37
+ test = {
38
+ request: {
39
+ baseURL: '={{$credentials.domain.trim().replace(/\\/+$/, "").startsWith("http") ? $credentials.domain.trim().replace(/\\/+$/, "") : "https://" + $credentials.domain.trim().replace(/\\/+$/, "")}}',
40
+ url: '/api/v1',
41
+ method: 'GET',
42
+ },
43
+ };
44
+ }
45
+ exports.FiretellApi = FiretellApi;
46
+ //# sourceMappingURL=FiretellApi.credentials.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"FiretellApi.credentials.js","sourceRoot":"","sources":["../../credentials/FiretellApi.credentials.ts"],"names":[],"mappings":";;;AAOA,MAAa,WAAW;IACtB,IAAI,GAAG,aAAa,CAAC;IACrB,WAAW,GAAG,cAAc,CAAC;IAC7B,gBAAgB,GACd,qEAAqE,CAAC;IAExE,UAAU,GAAsB;QAC9B;YACE,WAAW,EAAE,kBAAkB;YAC/B,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0BAA0B;YACvC,WAAW,EACT,oGAAoG;SACvG;QACD;YACE,WAAW,EAAE,gBAAgB;YAC7B,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC/B,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,QAAQ;YACrB,WAAW,EACT,oGAAoG;SACvG;KACF,CAAC;IAEF,YAAY,GAAyB;QACnC,IAAI,EAAE,SAAS;QACf,UAAU,EAAE;YACV,OAAO,EAAE;gBACP,aAAa,EAAE,oCAAoC;aACpD;SACF;KACF,CAAC;IAEF,IAAI,GAA2B;QAC7B,OAAO,EAAE;YACP,OAAO,EACL,0LAA0L;YAC5L,GAAG,EAAE,SAAS;YACd,MAAM,EAAE,KAAK;SACd;KACF,CAAC;CACH;AA/CD,kCA+CC"}
@@ -0,0 +1,15 @@
1
+ import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodePropertyOptions, INodeType, INodeTypeDescription } from 'n8n-workflow';
2
+ export declare class Firetell implements INodeType {
3
+ description: INodeTypeDescription;
4
+ methods: {
5
+ loadOptions: {
6
+ getPhoneNumbers(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
7
+ getVoiceAgents(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
8
+ getKnowledgeBases(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
9
+ getAddressBooks(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
10
+ getAgents(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
11
+ getTeams(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
12
+ };
13
+ };
14
+ execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
15
+ }