Package Information
Documentation
WindowEdge AI for n8n
This is an n8n community node for sending lead submissions into WindowEdge AI.
n8n is a workflow automation platform.
- Installation
- Operations
- Credentials
- Compatibility
- Usage
- Example workflow
- Development
- Publishing
- Resources
- Version history
Installation
After the package is published to npm, install it from the n8n community nodes interface:
@windowedge/n8n-nodes-windowedge-ai
Follow the n8n community-node installation guide.
Operations
Lead
- Create: Send a new lead to WindowEdge AI for ingestion and optional outreach.
The operation supports contact information, address details, outreach mode, SMS consent,
attribution, routing, custom fields, and test mode.
Credentials
Create a WindowEdge AI Web-Form API credential with:
- Web-Form Secret Key: A secret WindowEdge lead-ingestion key, usually beginning with
wf_. - Base URL: Keep the default
https://api.windowedge.aiunless WindowEdge support
provides a different API host.
Do not use a browser or public we_* key. Public keys are not accepted by this endpoint.
The credential test sends an authenticated request to:
GET /api/v1/lead-ingestion/connection
Compatibility
- Target n8n version: n8n 2.x.
- Build-time workflow types:
n8n-workflow2.16.0. - Development runtime: Node.js 22.22.0 or later.
- n8n 1.x is not tested or supported by this package.
Usage
- Add the WindowEdge AI node to a workflow.
- Select the Lead resource and Create operation.
- Select a WindowEdge credential.
- Enter the lead phone number.
- Choose AI Generated or Static outreach.
- Add optional lead, attribution, routing, and custom fields.
- Execute the workflow.
SMS consent
SMS Opt-In defaults to false. Set it to true only when the lead affirmatively
consented to SMS outreach. Store the disclosure shown to the lead in SMS Opt-In Language.
Tenant routing options
The Business Phone and SMS Agent fields load enabled options for the authenticated
tenant from WindowEdge AI. If the list cannot be loaded or the desired value is not listed,
switch the field to By Phone Number or By ID and enter the value manually.
Request endpoint
The node posts to:
POST /api/v1/lead-ingestion/leads
Authorization: Bearer <wf-secret-key>
Content-Type: application/json
Empty strings and empty objects are removed before the request is sent. The resulting body
uses the lead, outreach, attribution, routing, custom_fields, and test fields.
Example workflow
Import examples/create-test-lead.workflow.json
into n8n. Before executing it:
- Replace the example phone number with a sanctioned test destination.
- Select a WindowEdge credential.
- Keep Test Lead enabled.
- Review the SMS consent value before execution.
The example does not contain credentials or secrets.
Development
npm install
npm run lint
npm test
npm run build
npm pack --dry-run
npm test builds the package and runs focused tests against the compiled output.
Publishing
Publishing is tag-triggered through .github/workflows/publish.yml. The workflow:
- Confirms the Git tag matches
package.jsonexactly, allowing an optionalvprefix. - Installs dependencies with
npm ci. - Runs lint, tests, build, and an npm package dry run.
- Publishes with an npm provenance statement.
n8n requires Creator Portal submissions to be published from GitHub Actions with
provenance. Configure npm Trusted Publisher for publish.yml, or use a package-scoped
granular NPM_TOKEN for the first publish.
Resources
- WindowEdge form submissions
- WindowEdge tracking and lead capture
- WindowEdge documentation
- n8n community nodes
- n8n community-node verification
Version history
- 0.1.0: Initial lead-ingestion node with credential testing, tenant routing choices,
manual routing fallback, test mode, and explicit SMS consent handling.