Marketing Automation

Heyreach

Learn how to use Heyreach with Composio

Overview

SLUG: HEYREACH

Description

HeyReach is a multichannel outreach platform designed to help businesses and professionals engage with their audience effectively.

Authentication Details

generic_api_key
stringRequired

Connecting to Heyreach

Create an auth config

Use the dashboard to create an auth config for the Heyreach toolkit. This allows you to connect multiple Heyreach accounts to Composio for agents to use.

1

Select App

Navigate to Heyreach.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Heyreach Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4heyreach_auth_config_id = "ac_YOUR_HEYREACH_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": user_api_key}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Heyreach for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, heyreach_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Heyreach toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["HEYREACH"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Check API Key

Description

Tool to check if the api key is valid. use before making other api calls to confirm authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Empty List

Description

Tool to create an empty list. use after deciding on list name and type.

Action Parameters

name
stringRequired
type
stringDefaults to USER_LIST

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Webhook

Description

Tool to create a new webhook. use when you need programmatic callbacks for heyreach events after confirming a valid api key.

Action Parameters

campaignIds
array
eventType
stringRequired
webhookName
stringRequired
webhookUrl
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Webhook

Description

Tool to delete an existing webhook. use when you need to remove callbacks for outdated or unwanted webhooks.

Action Parameters

webhookId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All Campaigns

Description

Tool to retrieve all campaigns. use when you need a paginated list of campaigns for management or reporting.

Action Parameters

accountIds
array
keyword
string
limit
integerDefaults to 10
offset
integer
statuses
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All Leads

Description

Tool to retrieve all leads in a heyreach list. use when you need paginated collection of leads after confirming a valid api key.

Action Parameters

createdFrom
string
createdTo
string
keyword
string
leadLinkedInId
string
leadProfileUrl
string
limit
integerDefaults to 100
listId
integerRequired
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All LinkedIn Accounts

Description

Tool to retrieve all linkedin accounts. use when you need a paginated list of linkedin accounts after confirming a valid api key.

Action Parameters

keyword
string
limit
integerDefaults to 10
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All Lists

Description

Tool to retrieve all lists. use when you need a paginated list of lists after confirming a valid api key.

Action Parameters

limit
integerDefaults to 10
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All Webhooks

Description

Tool to retrieve all webhooks. use when you need a paginated collection of webhooks after confirming a valid api key.

Action Parameters

limit
integerDefaults to 100
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Companies From List

Description

Tool to get companies from a company list. use when you need a paginated list of companies after specifying a list id.

Action Parameters

keyword
string
limit
integerDefaults to 10
listId
integerRequired
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Conversations V2

Description

Tool to retrieve paginated linkedin conversations with advanced filters. use when you need to fetch inbox conversations filtered by lead or profile details.

Action Parameters

filters
objectRequired
limit
integerDefaults to 10
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Lead

Description

Tool to retrieve detailed information for a lead by profile url. use after obtaining the exact linkedin profile url to fetch full lead details.

Action Parameters

profileUrl
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Leads From List

Description

Tool to get a paginated list of leads from a lead list. use when you need to filter and page through leads for a specific list.

Action Parameters

createdFrom
string
createdTo
string
keyword
string
leadLinkedInId
string
leadProfileUrl
string
limit
integerDefaults to 10
listId
integerRequired
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get My Network for Sender

Description

Tool to get the linkedin network for a specified sender account. use when you need to retrieve paginated connections for a sender.

Action Parameters

pageNumber
integerRequired
pageSize
integerRequired
senderId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Webhook By ID

Description

Tool to retrieve a webhook by its id. use when you need detailed configuration of a specific webhook after listing or creating it.

Action Parameters

webhookId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Webhook

Description

Tool 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.

Action Parameters

campaignIds
array
eventType
string
isActive
boolean
webhookId
stringRequired
webhookName
string
webhookUrl

Action Response

data
objectRequired
error
string
successful
booleanRequired