Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Overview
This node interacts with the Campaign Management API to retrieve a list of leads currently in a campaign's hopper. The "Hopper List" operation fetches lead data from a specified campaign, allowing users to monitor or process leads queued for dialing or other campaign activities.
Common scenarios include:
- Exporting current leads in a campaign hopper for reporting or analysis.
- Integrating lead hopper data into workflows for further processing or decision-making.
- Monitoring campaign progress by checking which leads are pending contact.
For example, a user might use this node to pull all leads in a campaign hopper and then filter or route them based on lead attributes or status.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "Hopper List" for this operation. |
| User | API user credential used for authentication. |
| Pass | API password credential used for authentication. |
| Source | Description of what originated the API call; default is "n8n". |
| Campaign Id | Identifier of the campaign whose hopper leads are being requested. |
| Stage | Output format of the response; options: Csv, Tab, Pipe, Json. |
| Header | Whether to include a header row in the output; options: YES, NO. |
| Search Method | Method to search leads; options: LEAD ID, VENDOR LEAD CODE, PHONE NUMBER. |
Output
The node outputs the response from the API as JSON data under the json field. The structure depends on the selected output format (stage property):
- If
jsonis selected, the output will be structured JSON representing the hopper leads. - For other formats (Csv, Tab, Pipe), the output is a string formatted accordingly, optionally including headers if enabled.
No binary data output is indicated.
Dependencies
- Requires an API key credential (user and password) for authenticating with the Campaign Management API.
- The node sends HTTP requests to the configured API endpoint.
- No additional external dependencies beyond standard HTTP request capabilities.
Troubleshooting
- Authentication errors: Ensure that the provided user and password credentials are correct and have sufficient permissions.
- Invalid Campaign ID: Verify that the campaign ID exists and is active.
- Output format issues: Selecting an unsupported output format may cause parsing errors downstream; use one of the provided options.
- Empty results: If no leads are returned, confirm that the campaign hopper contains leads and that the search method matches existing lead identifiers.
Links and References
- Refer to the Campaign Management API documentation for details on the "hopper_list" function and its parameters.
- n8n documentation on creating and using HTTP request nodes for API integration.