Skip to main content
Heyreach logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: HEYREACH
  • Version: 20261101_00

Tools

Slug: HEYREACH_ADD_LEADS_TO_LIST_V2Tool to add leads to a lead list in HeyReach for LinkedIn campaigns. Accepts up to 100 leads per request and returns counts of added, updated, and failed leads.

Input Parameters

array
required
Array of lead objects to add. Maximum 100 leads per request.
integer
required
The ID of the list to add leads to. Must be an existing list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_CHECK_API_KEYTool to check if the API key is valid. Use before making other API calls to confirm authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_CREATE_EMPTY_LISTTool to create an empty list. Use after deciding on the list name and type.

Input Parameters

string
required
The name of the list to create.
string ("COMPANY_LIST" | "USER_LIST")
The type of list to create. Use ‘USER_LIST’ for leads and ‘COMPANY_LIST’ for companies. Defaults to ‘USER_LIST’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_CREATE_TAGSTool to create one or multiple tags for your workspace. Use when you need to organize leads with custom labels.

Input Parameters

array
required
Array of tag objects to create. Each tag must have a displayName and color.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_CREATE_WEBHOOKTool to create a new webhook. Use when you need programmatic callbacks for HeyReach events after confirming a valid API key.

Input Parameters

string ("CONNECTION_REQUEST_SENT" | "CONNECTION_REQUEST_ACCEPTED" | "MESSAGE_SENT" | "MESSAGE_REPLY_RECEIVED" | "INMAIL_SENT" | "INMAIL_REPLY_RECEIVED" | "FOLLOW_SENT" | "LIKED_POST" | "VIEWED_PROFILE" | "CAMPAIGN_COMPLETED" | "LEAD_TAG_UPDATED")
required
Type of event that triggers the webhook.
string
required
Destination URL where HeyReach will send POST event payloads.
array
List of campaign IDs to filter events. If empty, listens for the eventType across all campaigns.
string
required
Descriptive name for the webhook, used for identification. Maximum 25 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_DELETE_WEBHOOKTool to delete an existing webhook. Use when you need to remove callbacks for outdated or unwanted webhooks.

Input Parameters

string
required
Unique identifier of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_ALL_CAMPAIGNSTool to retrieve all campaigns. Use when you need a paginated list of campaigns for management or reporting.

Input Parameters

integer
Maximum number of campaigns to return (1-100)
integer
Number of campaigns to skip
string
Keyword to filter campaigns by name
array
Filter campaigns by statuses, e.g., [‘DRAFT’,‘PAUSED’]
array
Filter campaigns by LinkedIn account IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_ALL_LEADSTool to retrieve all leads in a HeyReach list. Use when you need paginated collection of leads after confirming a valid API key.

Input Parameters

integer
The maximum number of records to return, between 1 and 1000.
integer
required
The ID of the lead list.
integer
The number of records to skip for pagination.
string
Search term to filter leads by name or other relevant fields.
string
ISO 8601 end date for filtering leads by creation time.
string
ISO 8601 start date for filtering leads by creation time.
string
LinkedIn ID to filter leads.
string
LinkedIn profile URL to filter leads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_ALL_LINKEDIN_ACCOUNTSTool to retrieve all LinkedIn accounts. Use when you need a paginated list of LinkedIn accounts after confirming a valid API key.

Input Parameters

integer
Maximum number of accounts to return (1-100)
integer
Number of accounts to skip
string
Keyword to filter accounts by name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_ALL_LISTSTool to retrieve all lists. Use when you need a paginated list of lists after confirming a valid API key.

Input Parameters

integer
Maximum number of lists to return.
integer
Number of lists to skip for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_ALL_WEBHOOKSTool to retrieve all webhooks. Use when you need a paginated collection of webhooks after confirming a valid API key.

Input Parameters

integer
Maximum number of webhooks to return
integer
Number of webhooks to skip for pagination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_COMPANIES_FROM_LISTTool to get companies from a company list. Use when you need a paginated list of companies after specifying a list ID.

Input Parameters

integer
Maximum number of companies to return.
integer
required
The ID of the company list to retrieve companies from.
integer
Number of companies to skip for pagination.
string
Keyword to filter companies by name or description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_CONVERSATIONS_V2Tool to retrieve paginated LinkedIn conversations with advanced filters. Use when you need to fetch inbox conversations filtered by lead or profile details.

Input Parameters

integer
Maximum number of items to return (1-100)
integer
Number of items to skip for pagination
object
required
Filtering criteria for the conversations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_LEADTool to retrieve detailed information for a lead by profile URL. Use after obtaining the exact LinkedIn profile URL to fetch full lead details.

Input Parameters

string
required
The LinkedIn profile URL of the lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_LISTS_FOR_LEADRetrieve a paginated collection of lists containing a lead identified by LinkedIn profile URL. A 404 reporting that no lead matches the search is returned as an empty collection.

Input Parameters

integer
Maximum number of lists to return.
integer
Number of lists to skip for pagination.
string
required
The LinkedIn profile URL of the lead to find lists for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_MY_NETWORK_FOR_SENDERRetrieve a page of LinkedIn network connections for a specified sender account. Supply a zero-based page number and a positive page size to browse the sender’s network.

Input Parameters

integer
required
Number of items per page (must be positive)
integer
required
ID of the LinkedIn sender account for which to retrieve the network
integer
required
Zero-based index of the page to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_OVERALL_STATSRetrieve overall performance statistics for LinkedIn accounts and campaigns, including connection requests, messages, replies, and engagement rates. Filter by account IDs, campaign IDs, and date range; empty account or campaign ID lists select all accounts or campaigns, respectively.

Input Parameters

string
End date for statistics in ISO 8601 format (YYYY-MM-DD)
string
Start date for statistics in ISO 8601 format (YYYY-MM-DD)
array
Filter by specific LinkedIn account IDs (empty array returns stats for all accounts)
array
Filter by specific campaign IDs (empty array returns stats for all campaigns)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_GET_WEBHOOK_BY_IDTool to retrieve a webhook by its ID. Use when you need detailed configuration of a specific webhook after listing or creating it.

Input Parameters

integer
required
The unique identifier of the webhook to retrieve (positive integer)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_LIST_BLACKLISTED_COMPANIESList workspace-blacklisted companies with pagination and resolution filters.

Input Parameters

integer
Maximum number of blacklist entries to return (1-100).
integer
Number of blacklist entries to skip for pagination.
Case-insensitive search across company name and company URL.
string ("Matching" | "Matched" | "NotFound" | "BroadMatch")
Filter by company resolution status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_LIST_BLACKLISTED_LEADSList workspace-blacklisted leads and their resolution diagnostics.

Input Parameters

integer
Maximum number of blacklist entries to return, from 1 to 100.
integer
Number of blacklist entries to skip for pagination.
string
Case-insensitive identity search across lead names, emails, profile URLs, and LinkedIn member IDs.
string ("Matching" | "Matched" | "NotFound" | "BroadMatch")
Resolution status to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEYREACH_UPDATE_WEBHOOKTool to update an existing webhook’s configuration. Use when you need to modify a webhook’s name, URL, event type, campaigns, or activation status after confirming the webhookId.

Input Parameters

boolean
Activation status of the webhook. True to enable, False to disable, if omitted or null, the existing status is retained.
string ("CONNECTION_REQUEST_SENT" | "CONNECTION_REQUEST_ACCEPTED" | "MESSAGE_SENT" | "MESSAGE_REPLY_RECEIVED" | "INMAIL_SENT" | "INMAIL_REPLY_RECEIVED" | "FOLLOW_SENT" | "LIKED_POST" | "VIEWED_PROFILE" | "CAMPAIGN_COMPLETED" | "LEAD_TAG_UPDATED")
New event type to trigger the webhook. If omitted or null, the existing eventType is retained.
string
required
Unique identifier of the existing webhook to update.
string
New destination URL where HeyReach will send POST event payloads. If omitted or null, the existing URL is retained.
array
List of campaign IDs to scope the webhook. If omitted or null, retains existing campaigns; if empty list, listens for the eventType across all campaigns.
string
New name for the webhook. If omitted or null, the existing name is retained.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not