@automateitplease/n8n-nodes-smartlead

Community SmartLead node package for n8n.

Package Contents

• smartLead action node (resource/operation model)
• smartLeadTrigger trigger node (campaign + global webhook scopes)
• smartLeadApi credential (query-param api_key auth)

Installation

Community Nodes UI (self-hosted n8n)

1. Open Settings > Community Nodes.
2. Select Install.
3. Enter: @automateitplease/n8n-nodes-smartlead.
4. Accept risk notice and install.

npm

npm install @automateitplease/n8n-nodes-smartlead

Authentication

Use the SmartLead API credential:

• Create API key in SmartLead settings.
• Paste it into API Key field.

Security note: SmartLead requires api_key in query params. This package follows SmartLead's official auth behavior.

Operation Matrix (v1.0)

Trigger Node (smartLeadTrigger)

Parameters:

• scope: campaign or global
• campaignId: required for campaign scope
• associationType: required for global scope (1 user, 2 client, 3 campaign)
• associationId: required for global association types 2 and 3
• events (multi-select):
  • EMAIL_SENT
  • EMAIL_OPENED
  • EMAIL_CLICKED
  • EMAIL_REPLIED
  • EMAIL_BOUNCED
  • EMAIL_UNSUBSCRIBED
• normalizePayload: include normalized lead/event fields for downstream nodes

Lifecycle behavior:

• On activation: checks existing registration, then creates webhook if needed.
• On deactivation: deletes webhook registration.
• On receive: emits SmartLead payload (raw or normalized).

Example Workflows

Stored in examples/workflows:

1. reply-alerting.json
2. bounce-cleanup.json
3. campaign-health-digest.json
4. mailbox-warmup-monitoring.json
5. auto-tagging.json
6. reminder-automation.json
7. daily-analytics-sync.json
8. client-webhook-fanout.json

Local Development

Node.js >=22 is required.

npm install
npm run lint
npm run build
npm run test
npm run dev

Release + Verification

This repo includes GitHub Actions CI and npm publish with provenance (.github/workflows/publish.yml).

1. Configure npm Trusted Publisher for this GitHub repo/workflow.
2. Run npm run release.
3. Push created tag to trigger publish workflow.
4. After package is on npm, run scanner:

   npx @n8n/scan-community-package @automateitplease/n8n-nodes-smartlead
   

5. Submit in n8n Creator Portal.

Troubleshooting

• 401/403 auth failures: verify API key and SmartLead workspace/client scope.
• Trigger not firing: confirm webhook URL reachability from SmartLead and matching event selections.
• Duplicate webhooks: deactivate old workflow versions before re-activating new copies.
• API validation errors: pass endpoint-specific fields in Request Body/Query Parameters JSON.

Migration Notes (n8n-nodes-smartleadapi -> this package)

• Package name changes to @automateitplease/n8n-nodes-smartlead.
• Nodes are smartLead and smartLeadTrigger.
• Trigger supports both campaign and global webhook scopes.
• Broader v1 core coverage across inbox, analytics, smart delivery, and client ops.

Compatibility Policy

• Operation values introduced in 1.0.0 are treated as semver-stable.
• Future operation renames will ship with deprecation aliases before removal.

License

MIT