@automateitplease/n8n-nodes-smartlead
v1.0.4
Published
Community SmartLead integration for n8n with core API coverage and webhook trigger support
Downloads
38
Maintainers
Readme
@automateitplease/n8n-nodes-smartlead
Community SmartLead node package for n8n.
Package Contents
smartLeadaction node (resource/operation model)smartLeadTriggertrigger node (campaign + global webhook scopes)smartLeadApicredential (query-paramapi_keyauth)
Installation
Community Nodes UI (self-hosted n8n)
- Open Settings > Community Nodes.
- Select Install.
- Enter:
@automateitplease/n8n-nodes-smartlead. - Accept risk notice and install.
npm
npm install @automateitplease/n8n-nodes-smartleadAuthentication
Use the SmartLead API credential:
- Create API key in SmartLead settings.
- Paste it into
API Keyfield.
Security note: SmartLead requires api_key in query params. This package follows SmartLead's official auth behavior.
Operation Matrix (v1.0)
| Resource | Coverage | |---|---| | Campaign | list/get/create/delete/status/settings/schedule/sequences/email account attach-detach/subsequence/reply-forward/test/team-member | | Lead | add/list/get/update/pause/resume/mark-complete/unsubscribe/delete/message-history/activities/get-by-email/categories/list flows | | Email Account | list/get/add SMTP/add OAuth/update/delete/warmup update/stats/suspend-unsuspend/tag management | | Campaign Webhook | list/create-update/delete/summary/retrigger | | Global Webhook | create/get/update/delete | | Master Inbox | list views/get by ID/reply/forward/read status/category-revenue updates/reminders/notes/tasks/assignment | | Campaign Analytics | campaign stats/analytics/date-range analytics/lead stats/mailbox stats/export | | Global Analytics | top-level/campaign/client/mailbox/lead/team performance endpoints | | Smart Delivery | provider IDs/tests/reports/deliverability and mailbox health/folders | | Client | create/list/update/manage API keys | | Utility | verify email/send single email |
Trigger Node (smartLeadTrigger)
Parameters:
scope:campaignorglobalcampaignId: required forcampaignscopeassociationType: required forglobalscope (1 user,2 client,3 campaign)associationId: required for global association types2and3events(multi-select):EMAIL_SENTEMAIL_OPENEDEMAIL_CLICKEDEMAIL_REPLIEDEMAIL_BOUNCEDEMAIL_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:
reply-alerting.jsonbounce-cleanup.jsoncampaign-health-digest.jsonmailbox-warmup-monitoring.jsonauto-tagging.jsonreminder-automation.jsondaily-analytics-sync.jsonclient-webhook-fanout.json
Local Development
Node.js >=22 is required.
npm install
npm run lint
npm run build
npm run test
npm run devRelease + Verification
This repo includes GitHub Actions CI and npm publish with provenance (.github/workflows/publish.yml).
- Configure npm Trusted Publisher for this GitHub repo/workflow.
- Run
npm run release. - Push created tag to trigger publish workflow.
- After package is on npm, run scanner:
npx @n8n/scan-community-package @automateitplease/n8n-nodes-smartlead - Submit in n8n Creator Portal.
Troubleshooting
401/403auth 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 ParametersJSON.
Migration Notes (n8n-nodes-smartleadapi -> this package)
- Package name changes to
@automateitplease/n8n-nodes-smartlead. - Nodes are
smartLeadandsmartLeadTrigger. - 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.0are treated as semver-stable. - Future operation renames will ship with deprecation aliases before removal.
License
MIT
