> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alysio.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# HeyReach

> Connect Alysio to HeyReach using an API Key

## Overview

The HeyReach integration allows Alysio to securely connect with a user’s HeyReach account to manage LinkedIn outreach campaigns, lead lists, conversations, and campaign performance data.

Once connected, Alysio can retrieve campaigns, manage outreach activity, add leads to campaigns or lists, view LinkedIn conversations, and analyze campaign performance metrics using natural language queries.

The integration enables revenue and growth teams to manage LinkedIn automation workflows directly from Alysio without navigating the HeyReach interface.

Authentication is handled using a HeyReach API key, which allows Alysio to securely communicate with the HeyReach API on behalf of the user.

***

## Supported Data and Capabilities

The HeyReach integration provides access to several key outreach objects and operational workflows.

### Campaigns

Retrieve and manage LinkedIn outreach campaigns.

Supported campaign operations include:

Listing all campaigns\
Retrieving campaign details\
Pausing active campaigns\
Resuming paused campaigns\
Adding leads to campaigns\
Retrieving leads from campaigns\
Retrieving campaigns associated with a specific lead\
Stopping a lead within an active campaign

***

### Lists

Manage lead and company lists used in outreach campaigns.

Supported operations include:

Listing all lists\
Retrieving list details\
Retrieving leads from lists\
Retrieving companies from company lists\
Adding leads to lists\
Creating new lists\
Deleting leads from lists

Lists may contain individual leads or companies depending on the list type.

***

### Leads

Retrieve lead information using LinkedIn profile identifiers.

Lead retrieval allows Alysio to identify campaign membership, manage list placement, and track outreach interactions.

***

### Conversations

Retrieve LinkedIn conversation history associated with outreach campaigns.

This allows teams to view outreach responses and monitor engagement directly within Alysio.

***

### LinkedIn Accounts

Retrieve LinkedIn sender accounts connected to the HeyReach workspace.

LinkedIn account IDs are required when enrolling leads into campaigns.

***

### Network and Campaign Statistics

Retrieve campaign performance metrics and LinkedIn sender network information.

This includes metrics related to campaign activity, outreach performance, and LinkedIn connection status.

***

## Authentication

The HeyReach integration uses API key authentication.

Users must obtain an API key from their HeyReach account and enter the key when connecting the integration through the Alysio Settings → Integrations panel.

Unlike OAuth-based integrations, the HeyReach connection relies on a static API key that authenticates all requests sent to the HeyReach API.

***

## Credential Handling

The API key is securely stored within the Alysio platform and used to authenticate requests to the HeyReach API.

Each user or tenant maintains their own HeyReach credential, ensuring integration access remains isolated to the connected workspace.

If the API key is regenerated or rotated within HeyReach, the integration connection must be updated within Alysio.

If the integration is disconnected, HeyReach functionality will no longer be available until the user reconnects using a valid API key.

***

## Required Credentials

| Credential       | Purpose                                                                                                                              |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| HeyReach API Key | Authenticates requests to the HeyReach API for campaigns, lists, leads, conversations, LinkedIn accounts, and performance statistics |

API keys should be treated as sensitive credentials and stored securely.

If an API key becomes compromised, it should be regenerated in HeyReach and updated within Alysio.

***

## MCP Tools

The HeyReach MCP exposes several tools that allow Alysio to manage outreach campaigns and LinkedIn data.

***

### heyreach\_get\_all\_campaigns

Retrieves a paginated list of all campaigns.

Example prompts

List all HeyReach campaigns\
Show my outreach campaigns

***

### heyreach\_get\_campaign\_by\_id

Retrieves detailed information for a specific campaign.

Example prompts

Show details for campaign 123\
Get this campaign information

***

### heyreach\_make\_campaign\_resume

Resumes a paused outreach campaign.

Example prompts

Resume campaign X\
Turn the campaign back on

***

### heyreach\_make\_campaign\_pause

Pauses an active campaign.

Example prompts

Pause campaign X\
Stop this campaign

***

### heyreach\_add\_leads\_to\_campaign

Adds leads to a campaign.

Example prompts

Add these leads to campaign 123\
Enroll these prospects in the outreach campaign

***

### heyreach\_get\_leads\_from\_campaign

Retrieves leads enrolled in a specific campaign.

Example prompts

Show leads in campaign X\
List prospects in this campaign

***

### heyreach\_get\_campaigns\_for\_lead

Retrieves campaigns associated with a specific lead.

Example prompts

Which campaigns is this lead in\
Show campaigns for this prospect

***

### heyreach\_stop\_lead\_in\_campaign

Stops a lead’s participation in a campaign.

Example prompts

Remove this lead from the campaign\
Stop this prospect in outreach

***

### heyreach\_get\_all\_lists

Retrieves all lists within the HeyReach workspace.

Example prompts

Show all lists\
List HeyReach lead lists

***

### heyreach\_get\_leads\_from\_list

Retrieves leads contained within a list.

Example prompts

Show leads in this list\
Who is in list X

***

### heyreach\_get\_companies\_from\_list

Retrieves companies from a company-based list.

Example prompts

Show companies in this list\
List company accounts

This tool only works for lists with the type COMPANY\_LIST.

***

### heyreach\_add\_leads\_to\_list

Adds leads to an existing list.

Example prompts

Add these leads to the list\
Add prospects to list X

***

### heyreach\_get\_list\_by\_id

Retrieves detailed information for a list.

Example prompts

Show details for list 456\
Get this list information

***

### heyreach\_delete\_lead\_from\_list

Deletes leads from a list using the lead member ID.

Example prompts

Remove this lead from the list\
Delete prospects from this list

***

### heyreach\_delete\_lead\_from\_list\_by\_profile\_url

Deletes a lead from a list using their LinkedIn profile URL.

Example prompts

Remove this LinkedIn profile from the list

***

### heyreach\_get\_lead

Retrieves a lead using a LinkedIn profile URL.

Example prompts

Get this LinkedIn lead\
Show lead details for this profile

***

### heyreach\_create\_empty\_list

Creates a new empty list.

Example prompts

Create a new list\
Make a new outreach list

***

### heyreach\_get\_conversation\_history

Retrieves LinkedIn conversation history with filtering and pagination.

Example prompts

Show LinkedIn conversations\
Display outreach replies

***

### heyreach\_get\_linkdin\_accounts\_list

Retrieves LinkedIn accounts connected to the workspace.

Example prompts

Show LinkedIn sender accounts\
List connected LinkedIn profiles

These account IDs are required when enrolling leads into campaigns.

***

### heyreach\_get\_linked\_in\_account\_by\_id

Retrieves details for a specific LinkedIn account.

Example prompts

Show this LinkedIn account\
Get sender account details

***

### heyreach\_get\_is\_connection\_info

Checks whether a LinkedIn sender is connected to a lead.

Example prompts

Is this sender connected to the lead\
Check LinkedIn connection status

***

### heyreach\_get\_my\_network\_sender

Retrieves network information for a LinkedIn sender account.

Example prompts

Show my LinkedIn network\
Get sender network information

***

### heyreach\_get\_overall\_stats

Retrieves performance statistics for campaigns and LinkedIn senders.

Example prompts

Show HeyReach campaign stats\
Get outreach performance metrics

***

## App Behavior

Alysio retrieves HeyReach data on demand when users request campaign information or perform outreach actions.

There is no background synchronization between Alysio and HeyReach. Instead, API requests are executed in real time when users retrieve campaigns, manage leads, or analyze outreach performance.

All requests are authenticated using the stored HeyReach API key.

***

## Example Workflow

User asks

Add these leads to our Q1 LinkedIn outreach campaign

Alysio routes the request to the HeyReach MCP.

The MCP retrieves the campaign ID using heyreach\_get\_all\_campaigns and retrieves LinkedIn sender accounts using heyreach\_get\_linkdin\_accounts\_list.

The system sends a request using heyreach\_add\_leads\_to\_campaign with the appropriate campaign and account identifiers.

HeyReach processes the request and returns the result.

Alysio confirms the lead enrollment within the conversation interface.

***

## Troubleshooting

### HeyReach Not Connected

The API key has not been entered.

Solution\
Navigate to Settings → Integrations and enter your HeyReach API key.

***

### Authentication Error

The API key may be invalid or revoked.

Solution\
Regenerate the API key within HeyReach and update the integration connection.

***

### Lead Enrollment Issues

Adding leads to campaigns requires both campaignId and linkedInAccountId.

Solution\
Retrieve campaign IDs using heyreach\_get\_all\_campaigns and LinkedIn account IDs using heyreach\_get\_linkdin\_accounts\_list.

***

### Lead Removal Issues

Lead removal tools require the leadMemberId, which corresponds to the lead’s linkedin\_id.

Solution\
Retrieve the lead’s linkedin\_id using heyreach\_get\_leads\_from\_campaign or heyreach\_get\_leads\_from\_list.

***

### Company List Errors

Company retrieval only works for lists with the type COMPANY\_LIST.

Solution\
Verify the list type using heyreach\_get\_list\_by\_id.

***

## Support

For assistance configuring or troubleshooting the HeyReach integration, contact

[support@alysio.ai](mailto:support@alysio.ai)

Your Alysio onboarding or account team can also assist with integration setup and outreach workflow configuration.

***
