n8n-nodes-smartlead-test

A test n8n community node for SmartLead API integration.

🚀 Features

This node allows you to interact with the SmartLead API to:

• Campaigns: Get all campaigns or get a specific campaign by ID
• Leads: Get all leads from your entire account

📋 Prerequisites

• n8n version 0.187.0 or later
• SmartLead account with API access enabled

🔧 Installation

Method 1: Via n8n Community Nodes (Recommended)

1. Go to Settings → Community Nodes in your n8n instance
2. Click Install a community node
3. Enter: n8n-nodes-smartlead-test
4. Click Install
5. Restart n8n

Method 2: Manual Installation (Development)

# Clone and build
git clone <repository-url>
cd n8n-nodes-smartlead-test
npm install
npm run build

# Copy to n8n custom nodes directory
cp -r dist ~/.n8n/nodes/n8n-nodes-smartlead-test

🔐 Setting up Credentials

1. Get your SmartLead API Key:

   • Go to your SmartLead dashboard
   • Navigate to Settings → API
   • Click Activate API button
   • Copy your API key

2. Create Credentials in n8n:

   • In n8n, create new SmartLead API credentials
   • Paste your API key
   • Test the connection

📖 Usage

Campaign Operations

Get All Campaigns

• Resource: Campaign
• Operation: Get All
• Description: Retrieves all campaigns in your account

Get Campaign by ID

• Resource: Campaign
• Operation: Get
• Campaign ID: Enter the specific campaign ID
• Description: Retrieves details for a specific campaign

Lead Operations

Get All Leads

• Resource: Lead
• Operation: Get All
• Description: Retrieves all leads from your entire account

🔧 Development

Setup

npm install
npm run build

Available Scripts

• npm run build - Build the project
• npm run dev - Watch mode for development
• npm run lint - Run ESLint
• npm run format - Format code with Prettier

Project Structure

├── credentials/
│   └── SmartLeadApi.credentials.ts
├── nodes/
│   └── SmartLead/
│       └── SmartLead.node.ts
├── dist/                   # Built files
├── package.json
├── tsconfig.json
└── README.md

🌐 API Information

This node integrates with the SmartLead API:

• Base URL: https://server.smartlead.ai/api/v1
• Authentication: API key via query parameter
• Rate Limit: 60 requests per 60 seconds

For complete API documentation, visit: https://api.smartlead.ai/reference

⚠️ Current Limitations

This is a test version with basic functionality:

• Only supports GET operations
• Limited to campaigns and leads resources
• No batch operations yet
• No advanced filtering options

🚗 Roadmap

Future enhancements planned:

• ✅ Basic Campaign & Lead operations
• 🔄 Email Account Management
• 🔄 Campaign Creation & Updates
• 🔄 Lead Management (Create, Update, Delete)
• 🔄 Campaign Statistics
• 🔄 Rate limiting handling
• 🔄 Batch operations

🐛 Issues & Testing

When testing:

1. Ensure your SmartLead API key is valid
2. Check rate limits (60 requests/minute)
3. Verify campaign/lead IDs exist in your account

📄 License

MIT

🆘 Support

This is a test node for development purposes. For issues:

1. Check the SmartLead API documentation
2. Verify your credentials and permissions
3. Check n8n logs for detailed error messages

---

Note: This is a test version to validate the n8n community node approach for SmartLead integration. Production version will include all SmartLead API endpoints.