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

Tools

SLUG: HEYREACH_CHECK_API_KEY

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

SLUG: HEYREACH_CREATE_EMPTY_LIST

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

SLUG: HEYREACH_CREATE_WEBHOOK

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

SLUG: HEYREACH_DELETE_WEBHOOK

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

SLUG: HEYREACH_GET_ALL_CAMPAIGNS

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

SLUG: HEYREACH_GET_ALL_LEADS

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

SLUG: HEYREACH_GET_ALL_LINKEDIN_ACCOUNTS

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

SLUG: HEYREACH_GET_ALL_LISTS

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

SLUG: HEYREACH_GET_ALL_WEBHOOKS

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

SLUG: HEYREACH_GET_COMPANIES_FROM_LIST

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

SLUG: HEYREACH_GET_CONVERSATIONS_V2

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

SLUG: HEYREACH_GET_LEAD

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

SLUG: HEYREACH_GET_LEADS_FROM_LIST

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

SLUG: HEYREACH_GET_MY_NETWORK_FOR_SENDER

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

SLUG: HEYREACH_GET_WEBHOOK_BY_ID

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

SLUG: HEYREACH_UPDATE_WEBHOOK

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