Heyreach
heyreachHeyReach is a multichannel outreach platform designed to help businesses and professionals engage with their audience effectively.
Acciones disponibles (16)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Check API KeyHEYREACH_CHECK_API_KEYAcciónTool to check if the api key is valid. use before making other api calls to confirm authentication.
HEYREACH_CHECK_API_KEYAcciónTool to check if the api key is valid. use before making other api calls to confirm authentication.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Empty ListHEYREACH_CREATE_EMPTY_LISTAcciónTool to create an empty list. use after deciding on list name and type.
HEYREACH_CREATE_EMPTY_LISTAcciónTool to create an empty list. use after deciding on list name and type.
Parámetros de entrada
namestringObligatorioThe name of the list to create.
typestringenumThe type of list to create. 'USER_LIST' for leads, 'COMPANY_LIST' for companies. Defaults to 'USER_LIST'.
COMPANY_LISTUSER_LIST
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WebhookHEYREACH_CREATE_WEBHOOKAcciónTool to create a new webhook. use when you need programmatic callbacks for heyreach events after confirming a valid api key.
HEYREACH_CREATE_WEBHOOKAcciónTool to create a new webhook. use when you need programmatic callbacks for heyreach events after confirming a valid api key.
Parámetros de entrada
eventTypestringObligatorioenumType of event that triggers the webhook.
CONNECTION_REQUEST_SENTCONNECTION_REQUEST_ACCEPTEDMESSAGE_SENTMESSAGE_REPLY_RECEIVEDINMAIL_SENTINMAIL_REPLY_RECEIVEDFOLLOW_SENTLIKED_POSTVIEWED_PROFILECAMPAIGN_COMPLETEDLEAD_TAG_UPDATEDwebhookUrlstringObligatorioDestination URL where HeyReach will send POST event payloads.
campaignIdsinteger[]List of campaign IDs to filter events. If empty, listens for the eventType across all campaigns.
webhookNamestringObligatorioDescriptive name for the webhook, used for identification.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete WebhookHEYREACH_DELETE_WEBHOOKAcciónTool to delete an existing webhook. use when you need to remove callbacks for outdated or unwanted webhooks.
HEYREACH_DELETE_WEBHOOKAcciónTool to delete an existing webhook. use when you need to remove callbacks for outdated or unwanted webhooks.
Parámetros de entrada
webhookIdstringObligatorioUnique identifier of the webhook to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All CampaignsHEYREACH_GET_ALL_CAMPAIGNSAcciónTool to retrieve all campaigns. use when you need a paginated list of campaigns for management or reporting.
HEYREACH_GET_ALL_CAMPAIGNSAcciónTool to retrieve all campaigns. use when you need a paginated list of campaigns for management or reporting.
Parámetros de entrada
limitintegerMaximum number of campaigns to return (1-100)
offsetintegerNumber of campaigns to skip
keywordstringKeyword to filter campaigns by name
statusesstring[]Filter campaigns by statuses, e.g., ['DRAFT','PAUSED']
accountIdsinteger[]Filter campaigns by LinkedIn account IDs
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All LeadsHEYREACH_GET_ALL_LEADSAcciónTool to retrieve all leads in a heyreach list. use when you need paginated collection of leads after confirming a valid api key.
HEYREACH_GET_ALL_LEADSAcciónTool to retrieve all leads in a heyreach list. use when you need paginated collection of leads after confirming a valid api key.
Parámetros de entrada
limitintegerThe maximum number of records to return, between 1 and 1000.
listIdintegerObligatorioThe ID of the lead list.
offsetintegerThe number of records to skip for pagination.
keywordstringSearch term to filter leads by name or other relevant fields.
createdTostringISO 8601 end date for filtering leads by creation time.
createdFromstringISO 8601 start date for filtering leads by creation time.
leadLinkedInIdstringLinkedIn ID to filter leads.
leadProfileUrlstringLinkedIn profile URL to filter leads.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All LinkedIn AccountsHEYREACH_GET_ALL_LINKEDIN_ACCOUNTSAcciónTool to retrieve all linkedin accounts. use when you need a paginated list of linkedin accounts after confirming a valid api key.
HEYREACH_GET_ALL_LINKEDIN_ACCOUNTSAcciónTool to retrieve all linkedin accounts. use when you need a paginated list of linkedin accounts after confirming a valid api key.
Parámetros de entrada
limitintegerMaximum number of accounts to return (1-100)
offsetintegerNumber of accounts to skip
keywordstringKeyword to filter accounts by name
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All ListsHEYREACH_GET_ALL_LISTSAcciónTool to retrieve all lists. use when you need a paginated list of lists after confirming a valid api key.
HEYREACH_GET_ALL_LISTSAcciónTool to retrieve all lists. use when you need a paginated list of lists after confirming a valid api key.
Parámetros de entrada
limitintegerMaximum number of lists to return.
offsetintegerNumber of lists to skip for pagination.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All WebhooksHEYREACH_GET_ALL_WEBHOOKSAcciónTool to retrieve all webhooks. use when you need a paginated collection of webhooks after confirming a valid api key.
HEYREACH_GET_ALL_WEBHOOKSAcciónTool to retrieve all webhooks. use when you need a paginated collection of webhooks after confirming a valid api key.
Parámetros de entrada
limitintegerMaximum number of webhooks to return
offsetintegerNumber of webhooks to skip for pagination
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Companies From ListHEYREACH_GET_COMPANIES_FROM_LISTAcciónTool to get companies from a company list. use when you need a paginated list of companies after specifying a list id.
HEYREACH_GET_COMPANIES_FROM_LISTAcciónTool to get companies from a company list. use when you need a paginated list of companies after specifying a list id.
Parámetros de entrada
limitintegerMaximum number of companies to return.
listIdintegerObligatorioThe ID of the company list to retrieve companies from.
offsetintegerNumber of companies to skip for pagination.
keywordstringKeyword to filter companies by name or description.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Conversations V2HEYREACH_GET_CONVERSATIONS_V2AcciónTool to retrieve paginated linkedin conversations with advanced filters. use when you need to fetch inbox conversations filtered by lead or profile details.
HEYREACH_GET_CONVERSATIONS_V2AcciónTool to retrieve paginated linkedin conversations with advanced filters. use when you need to fetch inbox conversations filtered by lead or profile details.
Parámetros de entrada
limitintegerMaximum number of items to return (1-100)
offsetintegerNumber of items to skip for pagination
filtersobjectObligatorioFiltering criteria for the conversations
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get LeadHEYREACH_GET_LEADAcciónTool to retrieve detailed information for a lead by profile url. use after obtaining the exact linkedin profile url to fetch full lead details.
HEYREACH_GET_LEADAcciónTool to retrieve detailed information for a lead by profile url. use after obtaining the exact linkedin profile url to fetch full lead details.
Parámetros de entrada
profileUrlstringObligatorioThe LinkedIn profile URL of the lead.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Leads From ListHEYREACH_GET_LEADS_FROM_LISTAcciónTool 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.
HEYREACH_GET_LEADS_FROM_LISTAcciónTool 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.
Parámetros de entrada
limitintegerMaximum number of leads to return. Defaults to 10, max 1000.
listIdintegerObligatorioThe ID of the lead list to retrieve leads from.
offsetintegerNumber of leads to skip for pagination.
keywordstringA search term to filter leads by name or other relevant fields.
createdTostringISO 8601 timestamp. Only include leads created on or before this date.
createdFromstringISO 8601 timestamp. Only include leads created on or after this date.
leadLinkedInIdstringLinkedIn ID of the lead to filter by.
leadProfileUrlstringLinkedIn profile URL to filter by, e.g., 'https://www.linkedin.com/in/john-doe/'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get My Network for SenderHEYREACH_GET_MY_NETWORK_FOR_SENDERAcciónTool to get the linkedin network for a specified sender account. use when you need to retrieve paginated connections for a sender.
HEYREACH_GET_MY_NETWORK_FOR_SENDERAcciónTool to get the linkedin network for a specified sender account. use when you need to retrieve paginated connections for a sender.
Parámetros de entrada
pageSizeintegerObligatorioNumber of items per page (must be positive)
senderIdintegerObligatorioID of the LinkedIn sender account for which to retrieve the network
pageNumberintegerObligatorioZero-based index of the page to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Webhook By IDHEYREACH_GET_WEBHOOK_BY_IDAcciónTool to retrieve a webhook by its id. use when you need detailed configuration of a specific webhook after listing or creating it.
HEYREACH_GET_WEBHOOK_BY_IDAcciónTool to retrieve a webhook by its id. use when you need detailed configuration of a specific webhook after listing or creating it.
Parámetros de entrada
webhookIdintegerObligatorioThe unique identifier of the webhook to retrieve (positive integer)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update WebhookHEYREACH_UPDATE_WEBHOOKAcciónTool 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.
HEYREACH_UPDATE_WEBHOOKAcciónTool 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.
Parámetros de entrada
isActivebooleanActivation status of the webhook. True to enable, False to disable, if omitted or null, the existing status is retained.
eventTypestringenumNew event type to trigger the webhook. If omitted or null, the existing eventType is retained.
CONNECTION_REQUEST_SENTCONNECTION_REQUEST_ACCEPTEDMESSAGE_SENTMESSAGE_REPLY_RECEIVEDINMAIL_SENTINMAIL_REPLY_RECEIVEDFOLLOW_SENTLIKED_POSTVIEWED_PROFILECAMPAIGN_COMPLETEDLEAD_TAG_UPDATEDwebhookIdstringObligatorioUnique identifier of the existing webhook to update.
webhookUrlanyuriNew destination URL where HeyReach will send POST event payloads. If omitted or null, the existing URL is retained.
campaignIdsinteger[]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.
webhookNamestringNew name for the webhook. If omitted or null, the existing name is retained.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not