Package Exports
- n8n-nodes-heyreach
- n8n-nodes-heyreach/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (n8n-nodes-heyreach) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
n8n-nodes-heyreach
This is a HeyReach Community Node for n8n, enabling seamless integration with HeyReach in your workflows.
HeyReach is a powerful LinkedIn automation platform designed to help you scale and optimize your outreach campaigns.
This project make it easy to manage LinkedIn campaigns and automate your outreach directly from your workflows.
License
Installation
Available Operations
Credentials
Resources
Folder Structure
License
This project is licensed under the MIT License. See the LICENSE file for details.
Installation
Community Nodes (Recommended)
- Navigate to n8n and sign in.
- Go to Settings > Community Nodes
- Click Install
- Enter
n8n-nodes-heyreachand click Download - Restart your n8n instance
- The HeyReach node will appear in your node palette
Local Setup
- Clone the repository.
- Run
npm installto install dependencies. - Before running locally make sure
baseURLwhich can be found inHeyReach.node.tsis set to dev or staging endpoints. - Run
npm run buildeach time you have change or the for the very first time. - Reference the official n8n documentation for running and testing custom nodes locally
Credentials
Steps to obtain API KEY needed for authentication.
- Go to HeyReach app and sign in.
- Navigate to the Integrations section.
- Find the n8n card and click Connect Now.
- Click New API Key to generate an API key.
- Copy the generated API key.
- In n8n, create a new HeyReach connection.
- Paste the API key into the connection settings and save it.
β Thatβs it β your HeyReach account is now connected to n8n! π
Available Operations
π§ Campaign Management
- Retrieve all campaigns β Get a list of all campaigns.
- Retrieve a campaign β Get details of a specific campaign.
- Resume a campaign β Resume a paused campaign.
- Pause a campaign β Pause an active campaign.
- Stop a lead in campaign β Stop a specific lead within a campaign.
- Add leads to campaign β Add one or multiple leads to a campaign.
- Retrieve leads from campaign β Get leads from a campaign.
- Retrieve campaigns for a lead β Find all campaigns that a specific lead belongs to.
π¬ Inbox
- Retrieve all LinkedIn conversations - Get a list of all LinkedIn conversations.
- Retrieve a specific LinkedIn conversation and messages - Retrieve details of a particular LinkedIn conversation along with all associated messages.
- Send a message to a LinkedIn conversation - Send a new message to a specific LinkedIn conversation.
π§βπΌ Lead
- Retrieve the details of a specific lead - Get detailed information about a specific lead.
- Add tags to a lead - Add one or more tags to a lead to help categorize or filter.
- Retrieve all tags for a lead - Retrieve all tags associated with a specific lead.
- Replace all existing tags for a lead - Replace the current tags on a lead with a new set of tags.
π LinkedIn Account Actions
- Retrieve a list of LinkedIn accounts - Get all LinkedIn accounts connected to the system.
- Retrieve a LinkedIn account - Get details of a specific LinkedIn account.
π List Actions
- Retrieve a list - Get a specific list of leads.
- Retrieve all lists - Get all available lead lists.
- Retrieve leads from a list - Get all leads within a specific list.
- Delete leads from a list by LinkedIn ID - Remove one or more leads from a list using their LinkedIn IDs.
- Delete leads from a list by LinkedIn profile URL - Remove leads from a list using their LinkedIn profile URLs.
- Retrieve companies from a list - Get all associated companies from a specific list.
- Add leads to a list - Add one or more leads to a given list.
- Retrieve lists associated with a specific lead - Get all lists that include a specific lead.
- Create an empty list - Create a new list with no leads.
π My Network Actions
- Retrieve list of network connections for a sender account - Get all network connections associated with a given sender LinkedIn account.
π Stats Actions
- Retrieve overall statistics - Get general statistics across the system, such as lead or campaign performance.
πͺ Webhook Actions
- Retrieve all webhooks - Get a list of all configured webhooks.
- Retrieve a single webhook - Get the details of a specific webhook.
Resources
Folder Structure
nodes/HeyReach/operations/β Contains folders based on the available features.- Each feature has its own folder.
operationsfiles specify the category of the endpoints and request params for each API call.fieldsfiles describe the fields required for each request.
- The starting point for the integration is
HeyReach.node.ts.- Any new operations should be registered in this file.